-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOC: additional info for audformat.define #327
Merged
Merged
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
Codecov Report
|
hagenw
changed the title
WIP: DOC: additional information on audformat.define module
DOC: additional information on audformat.define module
Dec 6, 2022
hagenw
changed the title
DOC: additional information on audformat.define module
DOC: additional information on audformat.define
Dec 6, 2022
hagenw
changed the title
DOC: additional information on audformat.define
DOC: additional info for audformat.define
Dec 6, 2022
I spotted a few minor errors and will set to WIP until I have fixed them. |
hagenw
changed the title
DOC: additional info for audformat.define
WIP: DOC: additional info for audformat.define
Dec 6, 2022
hagenw
changed the title
WIP: DOC: additional info for audformat.define
DOC: additional info for audformat.define
Dec 6, 2022
Fixed typos and removed WIP, it's ready for review now. |
hagenw
commented
Dec 6, 2022
frankenjoe
reviewed
Dec 7, 2022
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.
This adds additional information to the
audformat.define
module as this contains values that shouldn't be changed as the are part of the audformat specifications and other values that are only recommendations and might be changed by a user.This is seems to me also a good preparation for including
audformat.define.Emotion
in a next step as proposed in #314.As this pull request involves several changes I will only pick a few representatives here.
First I added a general introduction to the sub-module
Then for each of the classes that defines values that are part of the audformat specification I added text describing where those definitions are used and mention that they shouldn't be changed, e.g.
If the audformat specification included a link to the entries in the
audformat.define
I replaced this by the actual values, as the format specification should be the ground truth on available values and not the implementation, e.g.If the define values are part of an attribute or return value of a class, I mention there that the expected values are provided by the corresponding class in
audformat.define
, e.g. foraudformat.Scheme.dtype
For classes where the values are not given by the audformat specifications, I mention that they can be changed by a user, e.g.
/cc @schruefer