mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-30 12:21:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

[3.6] bpo-28851: Improve namedtuple documentation (GH-1274) (GH-1286)

Browse source 
Clarify that a sequence of strings is the preferred value for 'field_names'.
(cherry picked from commit 97bf722fcd)
This commit is contained in:
Mariatta 2017-04-25 18:23:05 -07:00 • committed by GitHub
parent ea0efa3bc1
commit 16b6f971bd
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
Doc/library/collections.rst
View file

@ -771,9 +771,9 @@ they add the ability to access fields by name instead of position index.
helpful docstring (with typename and field_names) and a helpful :meth:`__repr__` helpful docstring (with typename and field_names) and a helpful :meth:`__repr__`
method which lists the tuple contents in a ``name=value`` format. method which lists the tuple contents in a ``name=value`` format.
The *field_names* are a single string with each fieldname separated by whitespace The *field_names* are a sequence of strings such as ``['x', 'y']``.
and/or commas, for example ``'x y'`` or ``'x, y'``. Alternatively, *field_names* Alternatively, *field_names* can be a single string with each fieldname
can be a sequence of strings such as ``['x', 'y']``. separated by whitespace and/or commas, for example ``'x y'`` or ``'x, y'``.
Any valid Python identifier may be used for a fieldname except for names Any valid Python identifier may be used for a fieldname except for names
starting with an underscore. Valid identifiers consist of letters, digits, starting with an underscore. Valid identifiers consist of letters, digits,