Skip to content
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

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

Merged
merged 1 commit into from
May 30, 2024

Conversation

miss-islington
Copy link
Contributor

@miss-islington miss-islington commented May 30, 2024

  • 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 commit ec1ba26)

Co-authored-by: Serhiy Storchaka storchaka@gmail.com


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

…ythonGH-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 commit ec1ba26)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants