Skip to content

gh-109218: Improve documentation for the complex() constructor #119687

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.

Sign up for GitHub

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

Merged
serhiy-storchaka merged 10 commits into from
May 30, 2024
Merged

gh-109218: Improve documentation for the complex() constructor #119687

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
e67380d
gh-109218: Improve documentation for the complex() constructor
serhiy-storchaka May 28, 2024
94deb98
Fix also cmath.rst.
serhiy-storchaka May 29, 2024
7182597
Apply suggestions from code review
serhiy-storchaka May 29, 2024
63ebe03
Move examples for complex() and float(). Add examples for int().
serhiy-storchaka May 29, 2024
28bae65
Merge branch 'main' into complex-constructor-docs
serhiy-storchaka May 29, 2024
944dc6c
Add an example for truncation.
serhiy-storchaka May 29, 2024
97a9e00
Rewrite the description of the complex format and use productionlist.
serhiy-storchaka May 30, 2024
d77833c
Apply suggestions from code review
serhiy-storchaka May 30, 2024
9664b6a
Update Doc/library/functions.rst
serhiy-storchaka May 30, 2024
c23c659
Update Doc/library/functions.rst
serhiy-storchaka May 30, 2024
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
Prev Previous commit
Next Next commit
Apply suggestions from code review 
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
  • Loading branch information
@serhiy-storchaka @AlexWaygood
serhiy-storchaka and AlexWaygood authored May 29, 2024
commit 718259756c25f8b9a00464cff98c7857cc41c8e5
8 changes: 5 additions & 3 deletions Doc/library/functions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -376,8 +376,8 @@ are always available. They are listed here in alphabetical order.
complex(string, /)
complex(real=0, imag=0)

Convert a string or a number to a complex number or create a complex number
from the real and imaginary parts.
Convert a single string or number to a complex number, or create a
complex number from real and imaginary parts.

If the argument is a string, it should contain a decimal number, optionally
preceded by a sign, and optionally followed by the ``j`` or ``J`` suffix,
Expand Down Expand Up @@ -412,7 +412,9 @@ are always available. They are listed here in alphabetical order.

If all arguments are omitted, returns ``0j``.

Examples::
Examples:

.. doctest::

>>> complex('+1.23')
(1.23+0j)
Expand Down