You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Currently, our docstrings use a mix of imperative and indicative moods
basically randomly.
- PEP 257 recommends using the imperative mood for the first line of
docstrings, which is also enforced by the Ruff rule
[D401](https://docs.astral.sh/ruff/rules/non-imperative-mood/#non-imperative-mood-d401).
So I believe the imperative form is more suitable for the docs purposes.
- In most cases, I have simply changed the verb form, but a few cases
required more rewording.
- I updated the pyproject configuration to enforce it.
0 commit comments