summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMark Dickinson <mdickinson@enthought.com>2012-09-20 19:51:14 (GMT)
committerMark Dickinson <mdickinson@enthought.com>2012-09-20 19:51:14 (GMT)
commit4e12ad19c984dc8dfdb8c326b0ea44c490408579 (patch)
treed1847774fdc425eb977b853007c4006fdb9ea7d6
parent694f2331c6959872e05f76c757799be0c4b00748 (diff)
downloadcpython-4e12ad19c984dc8dfdb8c326b0ea44c490408579.zip
cpython-4e12ad19c984dc8dfdb8c326b0ea44c490408579.tar.gz
cpython-4e12ad19c984dc8dfdb8c326b0ea44c490408579.tar.bz2
Issue 15985: fix round argument names in documentation. Thanks Chris Jerdonek.
-rw-r--r--Doc/library/functions.rst18
1 files changed, 9 insertions, 9 deletions
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index be5d4c7..17a0d1b 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -1132,18 +1132,18 @@ are always available. They are listed here in alphabetical order.
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::