Some of the methods we write can become quite large or confusing. Help clear up the confusion by writing Python docstrings for individual methods.
The type of docstring we want is called reST (examples). While reST is recommended by PEP 287, there are many other ways to do docstrings in Python. At the end of the day, we want consistent formatting, but if you believe there's a strong case to be made for using a different style than reST, we're happy to hear it!
An example method that would be quite useful to have a docstring for can be found here.
Some of the methods we write can become quite large or confusing. Help clear up the confusion by writing Python docstrings for individual methods.
The type of docstring we want is called reST (examples). While reST is recommended by PEP 287, there are many other ways to do docstrings in Python. At the end of the day, we want consistent formatting, but if you believe there's a strong case to be made for using a different style than reST, we're happy to hear it!
An example method that would be quite useful to have a docstring for can be found here.