-
-
Notifications
You must be signed in to change notification settings - Fork 287
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
Standard docstrings style for the codebase #1060
Labels
Comments
Hey @pedro-psb , I wanted to get your thoughts on using ruff for docstring standardisation instead of |
+1 for google style |
I didn't know ruff did that, I'm ok with giving it a try. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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: