Specify Documentation Strings during function definition : Doc String « Development « Python

1. Python
2. Development
3. Doc String

Specify Documentation Strings during function definition

 


# Here is an example of a multi-line docstring:

def my_function():
     """Do nothing, but document it.
 
     No, really, it doesn't do anything.
     """
     pass
 
print my_function.__doc__


           
         
  

Related examples in the same category

1.	Document string
2.	Why Use str on a doc string?
3.	api helper: Print methods and doc strings
4.	Sample Use of api helper for list
5.	Cheap and simple API helper