Issue 15985: fix round argument names in documentation. Thanks Chris Jerdonek.

This commit is contained in:
Mark Dickinson 2012-09-20 20:57:37 +01:00
parent a8e49638d1
commit 39e0fb01ef
1 changed files with 7 additions and 6 deletions

View File

@ -1192,13 +1192,14 @@ available. They are listed here in alphabetical order.
Added the possibility to write a custom :meth:`__reversed__` method. Added the possibility to write a custom :meth:`__reversed__` method.
.. function:: round(x[, n]) .. function:: round(number[, ndigits])
Return the floating point value *x* rounded to *n* digits after the decimal Return the floating point value *number* rounded to *ndigits* digits after
point. If *n* is omitted, it defaults to zero. The result is a floating point the decimal point. If *ndigits* is omitted, it defaults to zero. The result
number. Values are rounded to the closest multiple of 10 to the power minus is a floating point number. Values are rounded to the closest multiple of
*n*; if two multiples are equally close, rounding is done away from 0 (so. for 10 to the power minus *ndigits*; if two multiples are equally close,
example, ``round(0.5)`` is ``1.0`` and ``round(-0.5)`` is ``-1.0``). rounding is done away from 0 (so. for example, ``round(0.5)`` is ``1.0`` and
``round(-0.5)`` is ``-1.0``).
.. note:: .. note::