summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorcsabella <chekat2@gmail.com>2017-04-25 16:14:45 (GMT)
committerMariatta <Mariatta@users.noreply.github.com>2017-04-25 16:14:45 (GMT)
commit97bf722fcd1de1236824377e052369dc7686b644 (patch)
tree153f70f597cc2cc93e5ef7c578eb86eada331d99
parent3e2ad8ec61a322370a6fbdfb2209cf74546f5e08 (diff)
downloadcpython-97bf722fcd1de1236824377e052369dc7686b644.zip
cpython-97bf722fcd1de1236824377e052369dc7686b644.tar.gz
cpython-97bf722fcd1de1236824377e052369dc7686b644.tar.bz2
bpo-28851: Improve namedtuple documentation (GH-1274)
Clarify that a sequence of strings is the preferred value for 'field_names'.
-rw-r--r--Doc/library/collections.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/Doc/library/collections.rst b/Doc/library/collections.rst
index 8e2eb4d..2d51f0c 100644
--- a/Doc/library/collections.rst
+++ b/Doc/library/collections.rst
@@ -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__`
method which lists the tuple contents in a ``name=value`` format.
- The *field_names* are a single string with each fieldname separated by whitespace
- and/or commas, for example ``'x y'`` or ``'x, y'``. Alternatively, *field_names*
- can be a sequence of strings such as ``['x', 'y']``.
+ The *field_names* are a sequence of strings such as ``['x', 'y']``.
+ Alternatively, *field_names* can be a single string with each fieldname
+ 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
starting with an underscore. Valid identifiers consist of letters, digits,