Skip to content

gh-157135: Fix documentation errors in the half-turn *pi functions #157136

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
StanFromIreland merged 1 commit into from
Sep 8, 2026
+4 −4
Merged

gh-157135: Fix documentation errors in the half-turn *pi functions #157136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion Doc/library/math.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ noted otherwise, all return values are floats.
:func:`atan(x) <atan>` Arc tangent of *x*, in radians
:func:`atanpi(x) <atanpi>` Arc tangent of *x*, in half-turns
:func:`atan2(y, x) <atan2>` ``atan(y / x)``, in radians
:func:`atan2pi(y, x) <atan2pi>` ``atan(y / x)``, in half-turns
:func:`atan2pi(y, x) <atan2pi>` ``atanpi(y / x)``, in half-turns
:func:`cos(x) <cos>` Cosine of *x* radians
:func:`cospi(x) <cospi>` Cosine of *x⋅π* radians
:func:`sin(x) <sin>` Sine of *x* radians
Expand Down
6 changes: 3 additions & 3 deletions Modules/mathmodule.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@ m_asinpi(double x)

#ifndef HAVE_ATANPI
/*
asin(x)/pi. It conforms to C23 Annex 'F'.
atan(x)/pi. It conforms to C23 Annex 'F'.
*/

static double
Expand All @@ -274,7 +274,7 @@ m_atanpi(double x)

#ifndef HAVE_ATAN2PI
/*
asin(x)/pi. It conforms to C23 Annex 'F'.
atan2(y, x)/pi. It conforms to C23 Annex 'F'.
*/

static double
Expand Down Expand Up @@ -1136,7 +1136,7 @@ FUNC1D(atanh, atanh, 0,
FUNC1D(atanpi, m_atanpi, 0,
"atanpi($module, x, /)\n--\n\n"
"Return the arc tangent (measured in half-turns) of x.\n\n"
"The result is between 0 and 1.",
"The result is between -1/2 and 1/2.",
"expected a number in range from -1 up to 1, got %s")
FUNC1(cbrt, cbrt, 0,
"cbrt($module, x, /)\n--\n\n"
Expand Down
Loading