[ python-Bugs-926501 ] (ref-manual) position docstrings in source not documented

[SourceForge.net]

Bugs item #926501, was opened at 2004-03-31 07:40
Message generated for change (Tracker Item Submitted) made by Item Submitter
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=926501&group_id=5470

Category: Documentation
Group: None
Status: Open
Resolution: None
Priority: 5
Submitted By: a.hofkamp (axhlkhb)
Assigned to: Nobody/Anonymous (nobody)
Summary: (ref-manual) position docstrings in source not documented

Initial Comment:
A colleaque of mine could not find anything about doc
strings in the Python language ref manual. I checked
his claim and found that there is indeed very little
documented about docstrings in it.

The current (online) ref manual has a number of __doc__
entries in the index, they all point to structure
descriptions of internal objects (like a function object).
A 'documentation string' entry points to the docstring
of a code object.

What is not documented is where docstrings come from,
i.e. where in my program should I put it to make it
appear as __doc__ attribute.
The grammar only discusses Python statements.


----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=926501&group_id=5470