[Python-checkins] cpython (2.7): Minor doc clean-up.

Sat Mar 19 23:10:12 CET 2011

http://hg.python.org/cpython/rev/3a04bdda1ebf
changeset: 68690:3a04bdda1ebf
branch: 2.7
parent: 68672:94c158199277
user: Raymond Hettinger <python at rcn.com>
date: Sat Mar 19 15:09:00 2011 -0700
summary:
 Minor doc clean-up.
* Show list of fields option before showing the single string alternative.
* Remove the PS2 prompts so that the examples become cut-and-pastable.
files:
 Doc/library/collections.rst

diff --git a/Doc/library/collections.rst b/Doc/library/collections.rst
--- a/Doc/library/collections.rst
+++ b/Doc/library/collections.rst
@@ -565,9 +565,9 @@
 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,
@@ -595,7 +595,7 @@
 .. doctest::
 :options: +NORMALIZE_WHITESPACE
 
- >>> Point = namedtuple('Point', 'x y', verbose=True)
+ >>> Point = namedtuple('Point', ['x', 'y'], verbose=True)
 class Point(tuple):
 'Point(x, y)'
 <BLANKLINE>
@@ -699,7 +699,7 @@
 Point(x=33, y=22)
 
 >>> for partnum, record in inventory.items():
- ... inventory[partnum] = record._replace(price=newprices[partnum], timestamp=time.now())
+ inventory[partnum] = record._replace(price=newprices[partnum], timestamp=time.now())
 
 .. attribute:: somenamedtuple._fields
 
@@ -734,15 +734,15 @@
 a fixed-width print format:
 
 >>> class Point(namedtuple('Point', 'x y')):
- ... __slots__ = ()
- ... @property
- ... def hypot(self):
- ... return (self.x ** 2 + self.y ** 2) ** 0.5
- ... def __str__(self):
- ... return 'Point: x=%6.3f y=%6.3f hypot=%6.3f' % (self.x, self.y, self.hypot)
+ __slots__ = ()
+ @property
+ def hypot(self):
+ return (self.x ** 2 + self.y ** 2) ** 0.5
+ def __str__(self):
+ return 'Point: x=%6.3f y=%6.3f hypot=%6.3f' % (self.x, self.y, self.hypot)
 
 >>> for p in Point(3, 4), Point(14, 5/7.):
- ... print p
+ print p
 Point: x= 3.000 y= 4.000 hypot= 5.000
 Point: x=14.000 y= 0.714 hypot=14.018
 
@@ -768,7 +768,7 @@
 >>> Status.open, Status.pending, Status.closed
 (0, 1, 2)
 >>> class Status:
- ... open, pending, closed = range(3)
+ open, pending, closed = range(3)
 
 .. seealso::
 
-- 
Repository URL: http://hg.python.org/cpython
