]> granicus.if.org Git - python/commitdiff
Make the doctests in the docs pass, except for those in the turtle module.
authorGeorg Brandl <georg@python.org>
Tue, 28 Apr 2009 21:48:35 +0000 (21:48 +0000)
committerGeorg Brandl <georg@python.org>
Tue, 28 Apr 2009 21:48:35 +0000 (21:48 +0000)
Doc/howto/functional.rst
Doc/library/collections.rst
Doc/library/decimal.rst
Doc/library/subprocess.rst
Doc/whatsnew/2.7.rst

index d589f36b31726011acd414dc5249b3ad176d64a9..4f606d77db1f6614e0f27830aa38af87c69f224a 100644 (file)
@@ -472,7 +472,7 @@ Here's a sample usage of the ``generate_ints()`` generator:
 
     >>> gen = generate_ints(3)
     >>> gen
-    <generator object at ...>
+    <generator object generate_ints at ...>
     >>> gen.next()
     0
     >>> gen.next()
index a568d44f6ad73df87aaedb4243849e2a9e7d7d0b..eaab33e105f505475b6ea516811602398bae1978 100644 (file)
@@ -184,7 +184,7 @@ For example::
    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 @@ For example::
         >>> 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 @@ For example::
       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)]
index ebe0d8c5b20f826ad521bb99b596f5b820d32cd0..8d113152b62555ff31fa8f0f209cc081deea2752 100644 (file)
@@ -1850,7 +1850,7 @@ the :const:`Inexact` trap is set, it is also useful for validation:
    >>> 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?
index c95566bf20e8fe538795ab7bf03a56323709990c..4c4f4aea4798fece3ec1e9651b8a6aaec4c84077 100644 (file)
@@ -181,13 +181,13 @@ This module also defines two shortcut functions:
    :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"],
index f7dab79780952ec2c637d1b9e0713e441623c56b..24d4549b9e9de96f6a5c857325a1b116e3b49f8c 100644 (file)
@@ -220,21 +220,24 @@ changes, or look through the Subversion logs for all the details.
 * 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`::
-
-    >>> 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
+  raising a :exc:`KeyError`:
+
+  .. 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 @@ changes, or look through the Subversion logs for all the details.
        '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 @@ changes, or look through the Subversion logs for all the details.
   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')