From: Georg Brandl <georg@python.org>
Date: Sun, 21 Mar 2010 09:01:27 +0000 (+0000)
Subject: Fix some issues found by Jacques Ducasse on the docs list.
X-Git-Tag: v2.7b1~297
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=118c55778ee8516acfbcf5c5d4e2136793d0d311;p=python

Fix some issues found by Jacques Ducasse on the docs list.
---

diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index c248b12e04..1a4e9211d8 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -339,7 +339,7 @@ available.  They are listed here in alphabetical order.
    This function can also be used to execute arbitrary code objects (such as
    those created by :func:`compile`).  In this case pass a code object instead
    of a string.  If the code object has been compiled with ``'exec'`` as the
-   *kind* argument, :func:`eval`\'s return value will be ``None``.
+   *mode* argument, :func:`eval`\'s return value will be ``None``.
 
    Hints: dynamic execution of statements is supported by the :keyword:`exec`
    statement.  Execution of statements from a file is supported by the
@@ -1145,7 +1145,8 @@ available.  They are listed here in alphabetical order.
    value is ``None``.
 
    *key* specifies a function of one argument that is used to extract a comparison
-   key from each list element: ``key=str.lower``.  The default value is ``None``.
+   key from each list element: ``key=str.lower``.  The default value is ``None``
+   (compare the elements directly).
 
    *reverse* is a boolean value.  If set to ``True``, then the list elements are
    sorted as if each comparison were reversed.
diff --git a/Doc/library/pdb.rst b/Doc/library/pdb.rst
index cd1597f688..f6651ab266 100644
--- a/Doc/library/pdb.rst
+++ b/Doc/library/pdb.rst
@@ -22,7 +22,7 @@ supports post-mortem debugging and can be called under program control.
 
 The debugger is extensible --- it is actually defined as the class :class:`Pdb`.
 This is currently undocumented but easily understood by reading the source.  The
-extension interface uses the modules :mod:`bdb` (undocumented) and :mod:`cmd`.
+extension interface uses the modules :mod:`bdb` and :mod:`cmd`.
 
 The debugger's prompt is ``(Pdb)``. Typical usage to run a program under control
 of the debugger is::
diff --git a/Doc/library/stdtypes.rst b/Doc/library/stdtypes.rst
index 1a1ed4683f..3736ad0092 100644
--- a/Doc/library/stdtypes.rst
+++ b/Doc/library/stdtypes.rst
@@ -918,12 +918,12 @@ string functions based on regular expressions.
 
 .. method:: str.format(*args, **kwargs)
 
-   Perform a string formatting operation.  The *format_string* argument can
-   contain literal text or replacement fields delimited by braces ``{}``.  Each
-   replacement field contains either the numeric index of a positional argument,
-   or the name of a keyword argument.  Returns a copy of *format_string* where
-   each replacement field is replaced with the string value of the corresponding
-   argument.
+   Perform a string formatting operation.  The string on which this method is
+   called can contain literal text or replacement fields delimited by braces
+   ``{}``.  Each replacement field contains either the numeric index of a
+   positional argument, or the name of a keyword argument.  Returns a copy of
+   the string where each replacement field is replaced with the string value of
+   the corresponding argument.
 
       >>> "The sum of 1 + 2 is {0}".format(1+2)
       'The sum of 1 + 2 is 3'