Skip to content

Commit

Permalink
bpo-29677: DOC: clarify documentation for round (GH-877)
Browse files Browse the repository at this point in the history
  • Loading branch information
csabella authored and Mariatta committed Mar 29, 2017
1 parent a90e64b commit 85deefc
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions Doc/library/functions.rst
Expand Up @@ -1254,9 +1254,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
Expand All @@ -1266,6 +1266,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,
Expand Down

0 comments on commit 85deefc

Please sign in to comment.