summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorStan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>2025-01-04 17:38:57 (GMT)
committerGitHub <noreply@github.com>2025-01-04 17:38:57 (GMT)
commitf28d471fbe99f9eaac05d60ed40da47b0b56fe86 (patch)
tree1d0a01d15f7d602475e3a4c46e8ace1616ad3372 /Doc/library
parentfd94c6a8032676d0659aa9e38cdaa7c17093119c (diff)
downloadcpython-f28d471fbe99f9eaac05d60ed40da47b0b56fe86.zip
cpython-f28d471fbe99f9eaac05d60ed40da47b0b56fe86.tar.gz
cpython-f28d471fbe99f9eaac05d60ed40da47b0b56fe86.tar.bz2
gh-126719: Clarify math.fmod docs (#127741)
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/math.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/Doc/library/math.rst b/Doc/library/math.rst
index bf79b23..c78b313 100644
--- a/Doc/library/math.rst
+++ b/Doc/library/math.rst
@@ -248,7 +248,8 @@ Floating point arithmetic
.. function:: fmod(x, y)
- Return ``fmod(x, y)``, as defined by the platform C library. Note that the
+ Return the floating-point remainder of ``x / y``,
+ as defined by the platform C library function ``fmod(x, y)``. Note that the
Python expression ``x % y`` may not return the same result. The intent of the C
standard is that ``fmod(x, y)`` be exactly (mathematically; to infinite
precision) equal to ``x - n*y`` for some integer *n* such that the result has