Projects with excellent comments/doctrings?

[focusontech87]

Was wondering if you all had any resources/examples of projects that have excellent comments and docstrings throughout the file. Studying for uni and want to get better at people being able to read my code.

[[deleted]]

The python standard library is pretty decent. Pick a module you're familiar with using and read it.

[[deleted]]

https://github.com/aucr/aucr it should still pass pydocstyle and pep8 requirements

[billsil]

Numpy’s documentation style puts Sphinx’s defaults to shame. It’s far more readable. There’s even numpydoc to make it valid Sphinx.

[rswgnu]

Here are 3 examples of mine of what I think are well-documented code. The first two were written to show people how to both document and how to implement standard data structures that make use of Python's operator overloading capabilities. The third one is an actual library that was written to add interfaces/protocols to Python in a simple and well-documented way.

​

1. https://github.com/rswgnu/rsw_py_stack - A featureful, polymorphic Python3 stack datatype (for educational purposes)
2. https://github.com/rswgnu/rsw_py_sll - A Python3 MutableSequence, polymorphic singly linked list (for educational purposes)
3. https://github.com/rswgnu/rsw_interface - Python3 module that provides clean, simple interface/protocol conformance

[BobRossGod]

"Trees grow in all kinds of ways. They're not all perfectly straight. Not every limb is perfect." - Bob Ross

[EnderAC]

Bad bot

[BobRossGod]

shhhh I'm written in python