(ref-manual) position docstrings in source not documented

[axhlkhb]

BPO	926501
Nosy	@birkenfeld

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2008-07-20.11:50:36.501>
created_at = <Date 2004-03-31.07:40:20.000>
labels = ['docs']
title = '(ref-manual) position docstrings in source not documented'
updated_at = <Date 2008-07-20.11:50:36.499>
user = 'https://bugs.python.org/axhlkhb'

bugs.python.org fields:

activity = <Date 2008-07-20.11:50:36.499>
actor = 'georg.brandl'
assignee = 'none'
closed = True
closed_date = <Date 2008-07-20.11:50:36.501>
closer = 'georg.brandl'
components = ['Documentation']
creation = <Date 2004-03-31.07:40:20.000>
creator = 'axhlkhb'
dependencies = []
files = []
hgrepos = []
issue_num = 926501
keywords = []
message_count = 2.0
messages = ['60480', '70086']
nosy_count = 2.0
nosy_names = ['georg.brandl', 'axhlkhb']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = None
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue926501'
versions = []

[axhlkhb]

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.

[birkenfeld]

Added info in r65155.