NotificationsYou must be signed in to change notification settings
Fork32k
Star67.3k

[3.12] gh-109218: Improve documentation for the complex() constructor (GH-119687)#119805

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

serhiy-storchaka merged 1 commit intopython:3.12fromserhiy-storchaka:backport-ec1ba26-3.12

May 30, 2024

Merged

[3.12] gh-109218: Improve documentation for the complex() constructor (GH-119687)#119805

serhiy-storchaka merged 1 commit intopython:3.12fromserhiy-storchaka:backport-ec1ba26-3.12

May 30, 2024

Conversation

Copy link

Member

serhiy-storchaka commentedMay 30, 2024•
edited by github-actionsbot
Loading

Remove the equivalence with real+imag*1j which can be incorrect in corner cases (non-finite numbers, the sign of zeroes).
Separately document the three roles of the constructor: parsing a string, converting a number, and constructing a complex from components.
Document positional-only parameters of complex(), float(), int() and bool() as positional-only.
Add examples for complex() and int().
Specify the grammar of the string for complex().
Improve the grammar of the string for float().
Describe more explicitly the behavior when real and/or imag arguments are complex numbers. (This will be deprecated in future.) (cherry picked from commitec1ba26)

Issue:Invalid "equivalents" of the complex type constructor in docs #109218

📚 Documentation preview 📚:https://cpython-previews--119805.org.readthedocs.build/

[3.12]pythongh-109218: Improve documentation for the complex() const…

f9bcc87

…ructor (pythonGH-119687)* Remove the equivalence with real+imag*1j which can be incorrect in corner  cases (non-finite numbers, the sign of zeroes).* Separately document the three roles of the constructor: parsing a string,  converting a number, and constructing a complex from components.* Document positional-only parameters of complex(), float(), int() and bool()  as positional-only.* Add examples for complex() and int().* Specify the grammar of the string for complex().* Improve the grammar of the string for float().* Describe more explicitly the behavior when real and/or imag arguments are  complex numbers. (This will be deprecated in future.)(cherry picked from commitec1ba26)Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>