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

Based on my experience, the numpy docstring conventions (PEP257 superset) are the most widely-spread followed conventions that are also supported by tools, such as Sphinx.

One example:

Parameters
----------
x : type
    Description of parameter `x`.