]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-126719: Clarify math.fmod docs (#127741)
authorStan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Sat, 4 Jan 2025 17:38:57 +0000 (17:38 +0000)
committerGitHub <noreply@github.com>
Sat, 4 Jan 2025 17:38:57 +0000 (18:38 +0100)
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Doc/library/math.rst

index bf79b23a72bbf954bec00a83c3dfaa1baf0c19eb..c78b313db5152dad8141c53fb848a3dcaee37d9c 100644 (file)
@@ -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