What are the most common Python docstring formats?
Become part of the top 3% of the developers by applying to Toptal https://topt.al/25cXVn
--
Music by Eric Matyas
https://www.soundimage.org
Track title: Ocean Floor
--
Chapters
00:00 Question
00:21 Accepted answer (Score 1390)
03:17 Answer 2 (Score 354)
04:00 Answer 3 (Score 244)
05:29 Answer 4 (Score 67)
06:32 Thank you
--
Full question
https://stackoverflow.com/questions/3...
Accepted answer links:
[this blog post]: http://daouzli.com/blog/docstring.html
[PEP 287]: https://www.python.org/dev/peps/pep-0287
[Epydoc]: http://epydoc.sourceforge.net
[Sphinx]: http://sphinx-doc.org
[format]: https://github.com/google/styleguide/...
[Napoleon plugin]: https://sphinxcontrib-napoleon.readth...
[more examples]: https://www.sphinx-doc.org/en/master/...
[numpydoc]: https://numpydoc.readthedocs.io/en/la...
[Pyment]: https://github.com/dadadel/pyment
[Pyment documentation]: https://github.com/dadadel/pyment/blo...
Answer 2 links:
[Google style guide]: https://github.com/google/styleguide
[conventions for readable docstring syntax]: https://google.github.io/styleguide/p...
[Sphinx documentation tutorial]: https://pythonhosted.org/an_example_p...
Answer 3 links:
[PEP-257]: http://www.python.org/dev/peps/pep-0257/
Answer 4 links:
[specification of the format]: https://numpydoc.readthedocs.io/en/la...
[example]: https://github.com/numpy/numpy/blob/m...
[numpydoc]: https://github.com/numpy/numpydoc
http://docs.scipy.org/doc/numpy/refer...
[comparison]: http://sphinxcontrib-napoleon.readthe...
--
Content licensed under CC BY-SA
https://meta.stackexchange.com/help/l...
--
Tags
#python #codingstyle #documentation #docstring
#avk47
Watch video What are the most common Python docstring formats? online without registration, duration hours minute second in high quality. This video was added by user The Python Oracle 28 January 2023, don't forget to share it with your friends and acquaintances, it has been viewed on our site 14 once and liked it people.