Doc Strings : Documentation « Function « Python Tutorial
- Python Tutorial
- Function
- Documentation
def func(params):
"""Do something with a dictionary of parameters.
Parameter 1 is blah
Parameter 2 is blah
"""
class Foo :
""" This is a document string for the Foo class.
"""
x = 1
dir(Foo)
print Foo.__doc__