Skip to content

Remove outdated statement from math about C standard #134621

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.

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
3 changes: 0 additions & 3 deletions Doc/library/math.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,6 @@

--------------

This module provides access to the mathematical functions defined by the C
standard.

These functions cannot be used with complex numbers; use the functions of the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now this sentence seems weird. What "functions"? I think we should say that provides access to mathematical functions defined by the C standard and others. Or we can use the same sentence as for math.h on https://cplusplus.com/reference/cmath/:

Header declares a set of functions to compute common mathematical operations and transformations:

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "mathematical functions" in math that were just written in big letters :)

image

https://cpython-previews--134621.org.readthedocs.build/en/134621/library/math.html

Do you think it's not clear?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I personally don't think it's clear because I don't see the title as being tied with the first sentence. Maybe it's because I'm not native, but even in French I wouldn't referred to something that I said in a title. I also like the fact that we have a brief sentence starting with "This module" or something like that (AFAICT, it's a common way to introduce modules)

same name from the :mod:`cmath` module if you require support for complex
numbers. The distinction between functions which support complex numbers and
Expand Down
Loading