Docstring Style Standardization #67
Locked
AndrewSazonov
announced in
ADRs
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
This ADR standardizes docstrings to use the NumPy-style.
The decision is based on a comparison of the three main docstring styles currently relevant to our tooling and documentation workflow:
Sphinx-style,Google-style, andNumPy-style. All three styles are supported by our documentation build tools (MkDocs + mkdocstrings) and produce equivalent user-facing API reference documentation. Therefore, the main differences is in developer experience and tooling support.To help with converting existing docstrings to the selected style, the Python tool docstripy can be used. It is currently included in our template system.
NumPy-style example:
Links to the related discussions: #66
Beta Was this translation helpful? Give feedback.
All reactions