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

Document error behavior of audb.Dependencies methods #355

Open
hagenw opened this issue Jan 30, 2024 · 0 comments
Open

Document error behavior of audb.Dependencies methods #355

hagenw opened this issue Jan 30, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@hagenw
Copy link
Member

hagenw commented Jan 30, 2024

As stated in #354, the following methods all raise a KeyError at the moment if a file is requested that is not part of the deopendency table:

  • audb.Dependencies.__init__()
  • audb.Dependencies.archive()
  • audb.Dependencies.bit_depth()
  • audb.Dependencies.channels()
  • audb.Dependencies.checksum()
  • audb.Dependencies.duration()
  • audb.Dependencies.format()
  • audb.Dependencies.removed()
  • audb.Dependencies.sampling_rate()
  • audb.Dependencies.type()
  • audb.Dependencies.version()

We need to decide if we want to stick with this error, and add "Raises" sections to the docstrings of the methods.

@hagenw hagenw added the documentation Improvements or additions to documentation label Jan 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant