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

python doc strings are free-form, you can document it in any way you like.

Examples:

def mymethod(self, foo, bars):
    """
    Does neat stuff!
    Parameters:
      foo - a foo of type FooType to bar with.
      bars - The list of bars
    """

Now, there are some conventions, but python doesn't enforce any of them. Some projects have their own conventions. Some tools to work with docstrings also follow specific conventions.