-
-
Notifications
You must be signed in to change notification settings - Fork 120
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
Code snippet docstring formatting #291
Comments
Python has several different docstring formats - sorry for the dated reference. I don't think there's a canonical format, but happy to be corrected! I think here the docstrings are being used as comments so it's probably not critical that they are in a particular format, as long as they are consistent, other than to model good practise. |
I'm thinking here of PEP 257, https://peps.python.org/pep-0257/#one-line-docstrings |
Looks like your proposal is the best way to do things in this situation. |
If you can find time to prepare a PR, @deppen8 , I'll be happy to review. |
We have a number of Python code snippets that include a docstring where each new line starts with
*
. I think "canonical" Python formatting would tell us to use a one-line triple-quoted description.So this:
Would become this:
Thoughts?
The text was updated successfully, but these errors were encountered: