]> git.ipfire.org Git - thirdparty/Python/cpython.git/commit
[3.13] gh-109218: Improve documentation for the complex() constructor (GH-119687...
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Thu, 30 May 2024 20:44:20 +0000 (22:44 +0200)
committerGitHub <noreply@github.com>
Thu, 30 May 2024 20:44:20 +0000 (20:44 +0000)
commit844b535c51201a176865cea059533bf13a3826e2
treeb824eeedd92f7f8bda5b2fd15789acbeff2ee49b
parentd6bede815dd88adb9a89eda15c01573fd03af080
[3.13] gh-109218: Improve documentation for the complex() constructor (GH-119687) (GH-119803)

* 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 ec1ba264607b2b7b98d2602f5536a1d02981efc6)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Doc/library/cmath.rst
Doc/library/functions.rst
Objects/clinic/complexobject.c.h
Objects/complexobject.c