Skip to content

bpo-26701: Improve documentation for the rounding special methods. #6054

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 10, 2018
Merged

bpo-26701: Improve documentation for the rounding special methods. #6054

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 18 additions & 12 deletions Doc/reference/datamodel.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2364,28 +2364,17 @@ left undefined.
.. method:: object.__complex__(self)
object.__int__(self)
object.__float__(self)
object.__round__(self, [,n])

.. index::
builtin: complex
builtin: int
builtin: float
builtin: round

Called to implement the built-in functions :func:`complex`,
:func:`int`, :func:`float` and :func:`round`. Should return a value
:func:`int` and :func:`float`. Should return a value
of the appropriate type.


.. method:: object.__trunc__(self)

Called to implement :meth:`math.trunc`. Should return the value of the
object truncated to a :class:`numbers.Integral` (typically an
:class:`int`). If a class defines :meth:`__trunc__` but not
:meth:`__int__`, then :meth:`__trunc__` is called to implement the
built-in function :func:`int`.


.. method:: object.__index__(self)

Called to implement :func:`operator.index`, and whenever Python needs to
Expand All @@ -2401,6 +2390,23 @@ left undefined.
the same value.


.. method:: object.__round__(self, [,ndigits])
object.__trunc__(self)
object.__floor__(self)
object.__ceil__(self)

.. index:: builtin: round

Called to implement the built-in function :func:`round` and :mod:`math`
functions :func:`~math.trunc`, :func:`~math.floor` and :func:`~math.ceil`.
Unless *ndigits* is passed to :meth:`!__round__` all these methods should
return the value of the object truncated to an :class:`~numbers.Integral`
(typically an :class:`int`).

If :meth:`__int__` is not defined then the built-in function :func:`int`
falls back to :meth:`__trunc__`.


.. _context-managers:

With Statement Context Managers
Expand Down