[docs] docs Digest, Vol 62, Issue 70
Chris Jerdonek
chris.jerdonek at gmail.com
Fri Sep 28 23:52:27 CEST 2012
> Date: Wed, 12 Sep 2012 15:32:38 -0400
> From: Paul Fallon <paulfallon1106 at gmail.com>
> To: docs at python.org
> Subject: [docs] Documentation Strings
>
> For all us who are new to programming, it should be pointed out in the
> documentation that a double underscore is needed to get the docstring:
>>>>function_name.__doc__ <--- double underscores
Hi Paul,
Thanks for the suggestion. This is currently mentioned in the
tutorial portion of the documentation in the section called
"Documentation Strings" though:
http://docs.python.org/py3k/tutorial/controlflow.html#documentation-strings
It provides a code snippet very similar to the one that you provided.
--Chris
More information about the docs
mailing list