This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: (ref-manual) position docstrings in source not documented
Type: Stage:
Components: Documentation Versions:
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: Nosy List: axhlkhb, georg.brandl
Priority: normal Keywords:

Created on 2004-03-31 07:40 by axhlkhb, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Messages (2)
msg60480 - (view) Author: a.hofkamp (axhlkhb) Date: 2004-03-31 07:40
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.
msg70086 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2008-07-20 11:50
Added info in r65155.
History
Date User Action Args
2022-04-11 14:56:03adminsetgithub: 40108
2008-07-20 11:50:36georg.brandlsetstatus: open -> closed
resolution: fixed
messages: + msg70086
nosy: + georg.brandl
2004-03-31 07:40:20axhlkhbcreate