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

Extend docstrings of Dataset properties by Examples #101

Open
hagenw opened this issue Jul 25, 2024 · 1 comment
Open

Extend docstrings of Dataset properties by Examples #101

hagenw opened this issue Jul 25, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@hagenw
Copy link
Member

hagenw commented Jul 25, 2024

Usually, we add examples to the docstrings of functions/methods. I think it would make sense to also add examples to the cached properties of audbcards.Dataset.

I started with an example in #97.

@hagenw hagenw added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 25, 2024
@ChristianGeng
Copy link
Member

ChristianGeng commented Jul 25, 2024

I think that writing doctests as in #101 is hightly desirable.
Often I think though that the way in which doctesting is documented is underdeveloped.

CONTRIBUTING states that under the hood doctests are always executed as python -m pytest as this is not selective
on its input directories. pyproject.toml has the --doctest-modules also enabled.

I can run them separately by select the module directory :

pytest --doctest-modulesaudbcards/

But how do you get them more verbose? -vvvv -s have no effectl for me.

In case this is somehow possible then I would find this helpful to have it in CONTRIBUTING.

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 enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants