Skip to content
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 12 commits into from
Dec 7, 2022
Merged

DOC: additional info for audformat.define #327

merged 12 commits into from
Dec 7, 2022

Conversation

hagenw
Copy link
Member

@hagenw hagenw commented Dec 6, 2022

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

image

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.

image

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.

image

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. for audformat.Scheme.dtype

image

For classes where the values are not given by the audformat specifications, I mention that they can be changed by a user, e.g.

image

/cc @schruefer

@codecov
Copy link

codecov bot commented Dec 6, 2022

Codecov Report

Merging #327 (1b95b5a) into master (9077dfa) will not change coverage.
The diff coverage is 100.0%.

Impacted Files Coverage Δ
audformat/core/database.py 100.0% <ø> (ø)
audformat/core/index.py 100.0% <ø> (ø)
audformat/core/scheme.py 100.0% <ø> (ø)
audformat/core/table.py 100.0% <ø> (ø)
audformat/core/define.py 100.0% <100.0%> (ø)

@hagenw hagenw changed the title WIP: DOC: additional information on audformat.define module DOC: additional information on audformat.define module Dec 6, 2022
@hagenw hagenw changed the title DOC: additional information on audformat.define module DOC: additional information on audformat.define Dec 6, 2022
@hagenw hagenw changed the title DOC: additional information on audformat.define DOC: additional info for audformat.define Dec 6, 2022
@hagenw
Copy link
Member Author

hagenw commented Dec 6, 2022

I spotted a few minor errors and will set to WIP until I have fixed them.

@hagenw hagenw changed the title DOC: additional info for audformat.define WIP: DOC: additional info for audformat.define Dec 6, 2022
@hagenw hagenw changed the title WIP: DOC: additional info for audformat.define DOC: additional info for audformat.define Dec 6, 2022
@hagenw
Copy link
Member Author

hagenw commented Dec 6, 2022

I spotted a few minor errors and will set to WIP until I have fixed them.

Fixed typos and removed WIP, it's ready for review now.

@frankenjoe frankenjoe merged commit 22deb1d into master Dec 7, 2022
@frankenjoe frankenjoe deleted the define-docs branch December 7, 2022 09:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants