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

`int` fails back to `__trunc__` is `__int__` isn't defined, so cover
that in the docs.
(cherry picked from commit 308eab979d153f1ab934383dc08bc4546ced8b6c)

Co-authored-by: Eric Appelt <eric.appelt@gmail.com>

diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index 3ddd280f77ebc9c4c267c6a571f490a2453194d8..c3b6385723382ba882727b5651f961b4275a5e42 100644 (file)
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -731,8 +731,11 @@ are always available.  They are listed here in alphabetical order.
 
    Return an integer object constructed from a number or string *x*, or return
    ``0`` if no arguments are given.  If *x* is a number, return
-   :meth:`x.__int__() <object.__int__>`.  For floating point numbers, this
-   truncates towards zero.
+   :meth:`x.__int__() <object.__int__>`. If *x* defines
+   :meth:`x.__trunc__() <object.__trunc__>` but not
+   :meth:`x.__int__() <object.__int__>`, then return
+   if :meth:`x.__trunc__() <object.__trunc__>`.  For floating point numbers,
+   this truncates towards zero.
 
    If *x* is not a number or if *base* is given, then *x* must be a string,
    :class:`bytes`, or :class:`bytearray` instance representing an :ref:`integer

diff --git a/Doc/library/math.rst b/Doc/library/math.rst
index 55eb41b86f5d1623fae57f3d9756dff79bebc86c..33aec573a1f281b174c31458b25fda87c9f9faf4 100644 (file)
--- a/Doc/library/math.rst
+++ b/Doc/library/math.rst
@@ -203,7 +203,7 @@ Number-theoretic and representation functions
 
    Return the :class:`~numbers.Real` value *x* truncated to an
    :class:`~numbers.Integral` (usually an integer). Delegates to
-   ``x.__trunc__()``.
+   :meth:`x.__trunc__() <object.__trunc__>`.
 
 
 Note that :func:`frexp` and :func:`modf` have a different call/return pattern

diff --git a/Doc/reference/datamodel.rst b/Doc/reference/datamodel.rst
index 8b127a0b7e819fc451bdd19cdb4095190110a93e..26ad7b8c050c2f968b78e984fc7594e0d9583260 100644 (file)
--- a/Doc/reference/datamodel.rst
+++ b/Doc/reference/datamodel.rst
@@ -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