Created
April 30, 2024 14:44
-
-
Save danilovmy/2ca1736c48e959c3ca412ff6a15bfa33 to your computer and use it in GitHub Desktop.
Python Docstring arts and use cases
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| https://gist.github.com/nipunsadvilkar/fec9d2a40f9c83ea7fd97be59261c400 standard Python docstring format | |
| https://realpython.com/documenting-python-code/#docstring-types - about docstrings | |
| https://peps.python.org/pep-0484/#arbitrary-argument-lists-and-default-argument-values - typehints | |
| https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html - napoleon plugin for docstrings | |
| https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html - napoleon plugin for docstrings aternative docs | |
| https://numpydoc.readthedocs.io/en/latest/format.html - nympy docstrings format | |
| https://developer.lsst.io/python/numpydoc.html#py-docstring-sections - vera c. rubin observatory suggestions about docstrings | |
| https://www.datacamp.com/tutorial/docstrings-python - generic info about docstrings | |
| PyCharm docstrings generation: | |
| https://www.jetbrains.com/help/pycharm/creating-documentation-comments.html#-jcmzid_2 | |
| PyCharm docstrings autocomple popup: | |
| https://www.jetbrains.com/help/pycharm/using-docstrings-to-specify-types.html#example |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment