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

Review BDV related docstrings #47

Open
ehrenfeu opened this issue Mar 14, 2025 · 0 comments · May be fixed by #39
Open

Review BDV related docstrings #47

ehrenfeu opened this issue Mar 14, 2025 · 0 comments · May be fixed by #39
Assignees
Labels
conventions Issue with formatting / naming / ... documentation Missing documentation, docstring conventions, ... next-release Issues blocking the next release
Milestone

Comments

@ehrenfeu
Copy link
Member

ehrenfeu commented Mar 14, 2025

Since we're now having automatic ruff linting enabled through a GitHub Action, it's much easier to follow the conventions.

Particularly the recent changes in the bdv module and the related tests are triggering complaints.

Docstrings should be added or fixed, making sure that:

  • the summary line is concise and allows to understand the idea
  • more details are given in the followup section, if necessary
  • especially for tests-docstrings it is important to explain the test-flow (i.e. the idea of what the test does) properly, as this is sometimes extremely difficult to guess and understand from the test code itself

Current complaints can be seen in the details of the lint workflow, for example from run 13853569840.

@ehrenfeu ehrenfeu added conventions Issue with formatting / naming / ... documentation Missing documentation, docstring conventions, ... next-release Issues blocking the next release labels Mar 14, 2025
@ehrenfeu ehrenfeu added this to the 1.5.0 milestone Mar 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
conventions Issue with formatting / naming / ... documentation Missing documentation, docstring conventions, ... next-release Issues blocking the next release
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants