mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-01 02:38:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 15

bpo-26701: Add documentation for __trunc__ (GH-6022)

Browse source 
`int` fails back to `__trunc__` is `__int__` isn't defined, so cover
that in the docs.
This commit is contained in:
Eric Appelt 2018-03-10 02:44:12 -06:00 • committed by Nick Coghlan
parent 10485ebd40
commit 308eab979d
3 changed files with 15 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

9
Doc/reference/datamodel.rst
View file

@ -2377,6 +2377,15 @@ left undefined.
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