The Python Oracle

How to document class attributes in Python?

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: Puzzle Game Looping

--

Chapters
00:00 Question
02:32 Accepted answer (Score 125)
04:09 Answer 2 (Score 47)
05:36 Answer 3 (Score 32)
06:16 Answer 4 (Score 20)
08:09 Thank you

--

Full question
https://stackoverflow.com/questions/3051...

Question links:
[docstring style guidelines]: http://www.python.org/dev/peps/pep-0257/

Accepted answer links:
[specific meaning]: http://docs.python.org/library/functions...
[class attributes]: http://docs.python.org/tutorial/classes....

Answer 2 links:
[What is a docstring]: http://www.python.org/dev/peps/pep-0257/...
[PEP 258: Attribute Docstrings]: https://peps.python.org/pep-0258/#attrib...
[directive autoattribute
]: https://www.sphinx-doc.org/en/latest/usa...

Answer 3 links:
[PEP-224]: https://www.python.org/dev/peps/pep-0224/

--

Content licensed under CC BY-SA
https://meta.stackexchange.com/help/lice...

--

Tags
#python #class #documentation #docstring #classattributes

#avk47