bpo-29677: DOC: clarify documentation for round (GH-877) (GH-893)

(cherry picked from commit 85deefcf61)
This commit is contained in:
Mariatta 2017-03-29 19:10:22 -07:00 committed by GitHub
parent 9f8e090458
commit eef6e11f98

View file

@ -1233,9 +1233,9 @@ are always available. They are listed here in alphabetical order.
.. function:: round(number[, ndigits])
Return the floating point value *number* rounded to *ndigits* digits after
the decimal point. If *ndigits* is omitted or is ``None``, it returns the
nearest integer to its input. Delegates to ``number.__round__(ndigits)``.
Return *number* rounded to *ndigits* precision after the decimal
point. If *ndigits* is omitted or is ``None``, it returns the
nearest integer to its input.
For the built-in types supporting :func:`round`, values are rounded to the
closest multiple of 10 to the power minus *ndigits*; if two multiples are
@ -1245,6 +1245,9 @@ are always available. They are listed here in alphabetical order.
negative). The return value is an integer if called with one argument,
otherwise of the same type as *number*.
For a general Python object ``number``, ``round(number, ndigits)`` delegates to
``number.__round__(ndigits)``.
.. note::
The behavior of :func:`round` for floats can be surprising: for example,