Sign Up to our social questions and Answers Engine to ask questions, answer people’s questions, and connect with other people.
Login to our social questions & Answers Engine to ask questions answer people’s questions & connect with other people.
Lost your password? Please enter your email address. You will receive a link and will create a new password via email.
Please briefly explain why you feel this question should be reported.
Please briefly explain why you feel this answer should be reported.
Please briefly explain why you feel this user should be reported.
That’s it. If you want to document a function or a class, you put a string just after the definition. For instance:
def foo(): '''This function does nothing.''' pass But what about a module? How can I document what a file.py does?
For the packages, you can document it in
__init__.py. For the modules, you can add a docstring simply in the module file.All the information is here: http://www.python.org/dev/peps/pep-0257/