From: Raymond Hettinger <python@rcn.com>
Date: Mon, 9 Nov 2015 16:24:53 +0000 (-0800)
Subject: Improve namedtuple doc string examples
X-Git-Tag: v3.5.1rc1~77
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=850be0fb184ee1a5a42df5ecc1b8b62c433b1c6e;p=thirdparty%2FPython%2Fcpython.git

Improve namedtuple doc string examples
---

diff --git a/Doc/library/collections.rst b/Doc/library/collections.rst
index 0e5ff200085f..8ab757194a63 100644
--- a/Doc/library/collections.rst
+++ b/Doc/library/collections.rst
@@ -929,10 +929,10 @@ Docstrings can be customized by making direct assignments to the ``__doc__``
 fields:
 
    >>> Book = namedtuple('Book', ['id', 'title', 'authors'])
-   >>> Book.__doc__ = 'Hardcover book in active collection'
+   >>> Book.__doc__ += ': Hardcover book in active collection'
    >>> Book.id.__doc__ = '13-digit ISBN'
    >>> Book.title.__doc__ = 'Title of first printing'
-   >>> Book.author.__doc__ = 'List of authors sorted by last name'
+   >>> Book.authors.__doc__ = 'List of authors sorted by last name'
 
 Default values can be implemented by using :meth:`_replace` to
 customize a prototype instance:
diff --git a/Doc/whatsnew/3.5.rst b/Doc/whatsnew/3.5.rst
index 29d76b111289..f3db22fa7614 100644
--- a/Doc/whatsnew/3.5.rst
+++ b/Doc/whatsnew/3.5.rst
@@ -865,7 +865,7 @@ and improves their substitutability for lists.
 Docstrings produced by :func:`~collections.namedtuple` can now be updated::
 
     Point = namedtuple('Point', ['x', 'y'])
-    Point.__doc__ = 'ordered pair'
+    Point.__doc__ += ': Cartesian coodinate'
     Point.x.__doc__ = 'abscissa'
     Point.y.__doc__ = 'ordinate'