summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorcsabella <chekat2@gmail.com>2017-03-29 21:14:06 (GMT)
committerMariatta <Mariatta@users.noreply.github.com>2017-03-29 21:14:06 (GMT)
commit85deefcf61d3cc192846f41a4ccc6df17da60c98 (patch)
tree2be258d139ef544704cfddc85475d03ce77b088a /Doc
parenta90e64b78d74b80a7cbcca2237280c724b99431b (diff)
downloadcpython-85deefcf61d3cc192846f41a4ccc6df17da60c98.zip
cpython-85deefcf61d3cc192846f41a4ccc6df17da60c98.tar.gz
cpython-85deefcf61d3cc192846f41a4ccc6df17da60c98.tar.bz2
bpo-29677: DOC: clarify documentation for `round` (GH-877)
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/functions.rst9
1 files changed, 6 insertions, 3 deletions
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index 2c0ea71..90fb07a 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -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
@@ -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,