Docs: Improve type annotations and documentation for functions in wrappers.py
#1453
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…forced and song_sync functions in `wrappers.py`
BeritJanssen
reviewed
Jan 6, 2025
BeritJanssen
approved these changes
Jan 6, 2025
https://github.com/Amsterdam-Music-Lab/MUSCLE/pull/1453/files#r1904009282 We should document SongSync and Hooked in terms of the vocabulary that was already used in publications to describe the stratagem - not sure if this does so, can be left for later. Co-authored-by: Berit <berit.janssen@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Enhance clarity and usability of the
two_alternative_forcedandsong_syncfunctions by adding detailed type annotations and comprehensive docstrings.Related to #1428