[Python-checkins] r72085 - in python/trunk/Doc: howto/functional.rst library/collections.rst library/decimal.rst library/subprocess.rst whatsnew/2.7.rst

Tue Apr 28 23:48:36 CEST 2009

Author: georg.brandl
Date: Tue Apr 28 23:48:35 2009
New Revision: 72085
Log:
Make the doctests in the docs pass, except for those in the turtle module.
Modified:
 python/trunk/Doc/howto/functional.rst
 python/trunk/Doc/library/collections.rst
 python/trunk/Doc/library/decimal.rst
 python/trunk/Doc/library/subprocess.rst
 python/trunk/Doc/whatsnew/2.7.rst
Modified: python/trunk/Doc/howto/functional.rst
==============================================================================

--- python/trunk/Doc/howto/functional.rst	(original)
+++ python/trunk/Doc/howto/functional.rst	Tue Apr 28 23:48:35 2009
@@ -472,7 +472,7 @@
 
 >>> gen = generate_ints(3)
 >>> gen
- <generator object at ...>
+ <generator object generate_ints at ...>
 >>> gen.next()
 0
 >>> gen.next()
Modified: python/trunk/Doc/library/collections.rst
==============================================================================
--- python/trunk/Doc/library/collections.rst	(original)
+++ python/trunk/Doc/library/collections.rst	Tue Apr 28 23:48:35 2009
@@ -184,7 +184,7 @@
 class is similar to bags or multisets in other languages.
 
 Elements are counted from an *iterable* or initialized from another
- *mapping* (or counter)::
+ *mapping* (or counter):
 
 >>> c = Counter() # a new, empty counter
 >>> c = Counter('gallahad') # a new counter from an iterable
@@ -192,7 +192,7 @@
 >>> c = Counter(cats=4, dogs=8) # a new counter from keyword args
 
 Counter objects have a dictionary interface except that they return a zero
- count for missing items instead of raising a :exc:`KeyError`::
+ count for missing items instead of raising a :exc:`KeyError`:
 
 >>> c = Counter(['eggs', 'ham'])
 >>> c['bacon'] # count of a missing element is zero
@@ -225,7 +225,7 @@
 Return a list of the *n* most common elements and their counts from the
 most common to the least. If *n* is not specified, :func:`most_common`
 returns *all* elements in the counter. Elements with equal counts are
- ordered arbitrarily::
+ ordered arbitrarily:
 
 >>> Counter('abracadabra').most_common(3)
 [('a', 5), ('r', 2), ('b', 2)]
Modified: python/trunk/Doc/library/decimal.rst
==============================================================================
--- python/trunk/Doc/library/decimal.rst	(original)
+++ python/trunk/Doc/library/decimal.rst	Tue Apr 28 23:48:35 2009
@@ -1850,7 +1850,7 @@
 >>> Decimal('3.214').quantize(TWOPLACES, context=Context(traps=[Inexact]))
 Traceback (most recent call last):
 ...
- Inexact
+ Inexact: None
 
 Q. Once I have valid two place inputs, how do I maintain that invariant
 throughout an application?
Modified: python/trunk/Doc/library/subprocess.rst
==============================================================================
--- python/trunk/Doc/library/subprocess.rst	(original)
+++ python/trunk/Doc/library/subprocess.rst	Tue Apr 28 23:48:35 2009
@@ -181,13 +181,13 @@
 :attr:`returncode`
 attribute and output in the :attr:`output` attribute.
 
- The arguments are the same as for the :class:`Popen` constructor. Example:
+ The arguments are the same as for the :class:`Popen` constructor. Example::
 
 >>> subprocess.check_output(["ls", "-l", "/dev/null"])
 'crw-rw-rw- 1 root root 1, 3 Oct 18 2007 /dev/null\n'
 
 The stdout argument is not allowed as it is used internally.
- To capture standard error in the result, use stderr=subprocess.STDOUT.
+ To capture standard error in the result, use ``stderr=subprocess.STDOUT``::
 
 >>> subprocess.check_output(
 ["/bin/sh", "-c", "ls non_existent_file ; exit 0"],
Modified: python/trunk/Doc/whatsnew/2.7.rst
==============================================================================
--- python/trunk/Doc/whatsnew/2.7.rst	(original)
+++ python/trunk/Doc/whatsnew/2.7.rst	Tue Apr 28 23:48:35 2009
@@ -220,21 +220,24 @@
 * New class: the :class:`Counter` class in the :mod:`collections` module is
 useful for tallying data. :class:`Counter` instances behave mostly
 like dictionaries but return zero for missing keys instead of
- raising a :exc:`KeyError`::
+ raising a :exc:`KeyError`:
 
- >>> from collections import Counter
- >>> c=Counter()
- >>> for letter in 'here is a sample of english text':
- ... c[letter] += 1
- ...
- >>> c
- Counter({' ': 6, 'e': 5, 's': 3, 'a': 2, 'i': 2, 'h': 2,
- 'l': 2, 't': 2, 'g': 1, 'f': 1, 'm': 1, 'o': 1, 'n': 1,
- 'p': 1, 'r': 1, 'x': 1})
- >>> c['e']
- 5
- >>> c['z']
- 0
+ .. doctest::
+ :options: +NORMALIZE_WHITESPACE
+
+ >>> from collections import Counter
+ >>> c = Counter()
+ >>> for letter in 'here is a sample of english text':
+ ... c[letter] += 1
+ ...
+ >>> c
+ Counter({' ': 6, 'e': 5, 's': 3, 'a': 2, 'i': 2, 'h': 2,
+ 'l': 2, 't': 2, 'g': 1, 'f': 1, 'm': 1, 'o': 1, 'n': 1,
+ 'p': 1, 'r': 1, 'x': 1})
+ >>> c['e']
+ 5
+ >>> c['z']
+ 0
 
 There are two additional :class:`Counter` methods: :meth:`most_common`
 returns the N most common elements and their counts, and :meth:`elements`
@@ -247,7 +250,7 @@
 'a', 'a', ' ', ' ', ' ', ' ', ' ', ' ',
 'e', 'e', 'e', 'e', 'e', 'g', 'f', 'i', 'i',
 'h', 'h', 'm', 'l', 'l', 'o', 'n', 'p', 's',
- 's', 's', 'r', 't', 't', 'x']
+ 's', 's', 'r', 't', 't', 'x'
 
 Contributed by Raymond Hettinger; :issue:`1696199`.
 
@@ -257,7 +260,8 @@
 renamed to legal names that are derived from the field's
 position within the list of fields:
 
- >>> T=namedtuple('T', ['field1', '$illegal', 'for', 'field2'], rename=True)
+ >>> from collections import namedtuple
+ >>> T = namedtuple('T', ['field1', '$illegal', 'for', 'field2'], rename=True)
 >>> T._fields
 ('field1', '_1', '_2', 'field2')
 
