Docstring Format #502
reidsunderland
started this conversation in
Ideas
Docstring Format
#502
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Since Sphinx has been setup, we can use docstrings to document the code.
We should choose a format that we want to use for docstrings. @MagikEh found this site that demonstrates some of the standard formats.
This is an example of a Google formatted docstring for a class:
Example for a function:
IDEs like PyCharm can also automatically insert pre-formatted docstrings, and should support any of the linked styles.
Beta Was this translation helpful? Give feedback.
All reactions