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
Some parts of the codebase use Sphinx-style docstrings and others use Google's, and there is not a clear definition about this. Also, with the addition of auto-generated docs (#1058) , the docs render doesn't come out very pretty.
See here examples of these (and other) different styles.
We could use another style as well (if there is a strong opinion towards that). I would only argue that using a linter/auto-formatter should help get the codebase sharp.
The text was updated successfully, but these errors were encountered:
Hey @pedro-psb , I wanted to get your thoughts on using ruff for docstring standardisation instead of docformatter? ruff could be brought in for this use case, but eventually it could be swapped in as a replacement for flake8, black and import sorter too.
Problem
Some parts of the codebase use Sphinx-style docstrings and others use Google's, and there is not a clear definition about this. Also, with the addition of auto-generated docs (#1058) , the docs render doesn't come out very pretty.
See here examples of these (and other) different styles.
Proposal
Alternatives
We could use another style as well (if there is a strong opinion towards that). I would only argue that using a linter/auto-formatter should help get the codebase sharp.
The text was updated successfully, but these errors were encountered: