[Python-checkins] cpython (3.2): Issue 15985: fix round argument names in documentation. Thanks Chris Jerdonek.

mark.dickinson python-checkins at python.org
Thu Sep 20 21:52:21 CEST 2012


http://hg.python.org/cpython/rev/eccd94d4ee77
changeset:   79066:eccd94d4ee77
branch:      3.2
parent:      79060:786aa16aeda5
user:        Mark Dickinson <mdickinson at enthought.com>
date:        Thu Sep 20 20:51:14 2012 +0100
summary:
  Issue 15985: fix round argument names in documentation.  Thanks Chris Jerdonek.

files:
  Doc/library/functions.rst |  18 +++++++++---------
  1 files changed, 9 insertions(+), 9 deletions(-)


diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -1132,18 +1132,18 @@
    arguments starting at ``0``).
 
 
-.. function:: round(x[, n])
+.. function:: round(number[, ndigits])
 
-   Return the floating point value *x* rounded to *n* digits after the decimal
-   point.  If *n* is omitted, it defaults to zero.  Delegates to
-   ``x.__round__(n)``.
+   Return the floating point value *number* rounded to *ndigits* digits after
+   the decimal point.  If *ndigits* is omitted, it defaults to zero. Delegates
+   to ``number.__round__(ndigits)``.
 
    For the built-in types supporting :func:`round`, values are rounded to the
-   closest multiple of 10 to the power minus *n*; if two multiples are equally
-   close, rounding is done toward the even choice (so, for example, both
-   ``round(0.5)`` and ``round(-0.5)`` are ``0``, and ``round(1.5)`` is ``2``).
-   The return value is an integer if called with one argument, otherwise of the
-   same type as *x*.
+   closest multiple of 10 to the power minus *ndigits*; if two multiples are
+   equally close, rounding is done toward the even choice (so, for example,
+   both ``round(0.5)`` and ``round(-0.5)`` are ``0``, and ``round(1.5)`` is
+   ``2``).  The return value is an integer if called with one argument,
+   otherwise of the same type as *number*.
 
    .. note::
 

-- 
Repository URL: http://hg.python.org/cpython


More information about the Python-checkins mailing list