Skip to content

bpo-45584: Clarify the meaning of truncate in documentation #29183

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 8 commits into from
Apr 2, 2022
Merged

bpo-45584: Clarify the meaning of truncate in documentation #29183

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
e0a173d
bpo-45584: Clarify the meaning of `truncate` in documentation
Arthur-Milchior Oct 23, 2021
afaa3a2
Improved version of trunc documentation by Terry Reedy
Arthur-Milchior Nov 2, 2021
02ca5d3
Update Doc/library/math.rst
Arthur-Milchior Nov 2, 2021
2b0dc77
add space
merwok Nov 2, 2021
cbf5c61
Update Doc/library/math.rst
Arthur-Milchior Nov 3, 2021
af253ee
ceil and floor documentation uses :meth:
Arthur-Milchior Nov 27, 2021
569cff7
correct
Arthur-Milchior Nov 27, 2021
a00f434
Update Doc/library/math.rst
JelleZijlstra Apr 2, 2022
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
18 changes: 10 additions & 8 deletions Doc/library/math.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ Number-theoretic and representation functions
.. function:: ceil(x)

Return the ceiling of *x*, the smallest integer greater than or equal to *x*.
If *x* is not a float, delegates to ``x.__ceil__()``, which should return an
:class:`~numbers.Integral` value.
If *x* is not a float, delegates to :meth:`x.__ceil__ <object.__ceil__>`,
which should return an :class:`~numbers.Integral` value.


.. function:: comb(n, k)
Expand Down Expand Up @@ -77,9 +77,9 @@ Number-theoretic and representation functions

.. function:: floor(x)

Return the floor of *x*, the largest integer less than or equal to *x*.
If *x* is not a float, delegates to ``x.__floor__()``, which should return an
:class:`~numbers.Integral` value.
Return the floor of *x*, the largest integer less than or equal to *x*. If
*x* is not a float, delegates to :meth:`x.__floor__ <object.__floor__>`, which
should return an :class:`~numbers.Integral` value.


.. function:: fmod(x, y)
Expand Down Expand Up @@ -298,9 +298,11 @@ Number-theoretic and representation functions

.. function:: trunc(x)

Return the :class:`~numbers.Real` value *x* truncated to an
:class:`~numbers.Integral` (usually an integer). Delegates to
:meth:`x.__trunc__() <object.__trunc__>`.
Return *x* with the fractional part
removed, leaving the integer part. This rounds toward 0: ``trunc()`` is
equivalent to :func:`floor` for positive *x*, and equivalent to :func:`ceil`
for negative *x*. If *x* is not a float, delegates to :meth:`x.__trunc__
<object.__trunc__>`, which should return an :class:`~numbers.Integral` value.

.. function:: ulp(x)

Expand Down