]> git.ipfire.org Git - thirdparty/Python/cpython.git/commit
[3.12] gh-109218: Improve documentation for the complex() constructor (GH-119687...
authorSerhiy Storchaka <storchaka@gmail.com>
Thu, 30 May 2024 20:52:44 +0000 (23:52 +0300)
committerGitHub <noreply@github.com>
Thu, 30 May 2024 20:52:44 +0000 (20:52 +0000)
commit207d1b032fdc7f8921de220c29807925d1afa99b
tree29c9c3758c94ccbd57c0ddf8470f3e1264c7e802
parent2e31e5695d9c58cab4569a53cf097badd1141a5b
[3.12] gh-109218: Improve documentation for the complex() constructor (GH-119687) (ПР-119805)

* 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)
Doc/library/cmath.rst
Doc/library/functions.rst
Objects/clinic/complexobject.c.h
Objects/complexobject.c