How to document a method with parameter(s)?

Question

How to document methods with parameters using Python\'s documentation strings?

EDIT: PEP 257 gives this example:

d         


        

Answer 1

If you plan to use Sphinx to document your code, it is capable of producing nicely formatted HTML docs for your parameters with their 'signatures' feature. http://sphinx-doc.org/domains.html#signatures