From: csabella Date: Tue, 25 Apr 2017 16:14:45 +0000 (-0400) Subject: bpo-28851: Improve namedtuple documentation (GH-1274) X-Git-Tag: v3.7.0a1~905 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=97bf722fcd1de1236824377e052369dc7686b644;p=python bpo-28851: Improve namedtuple documentation (GH-1274) Clarify that a sequence of strings is the preferred value for 'field_names'. --- diff --git a/Doc/library/collections.rst b/Doc/library/collections.rst index 8e2eb4d9b0..2d51f0cfdc 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,