This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Document clarification: Section 5.4 Complex Number
Type: behavior Stage: resolved
Components: Documentation Versions: Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: terry.reedy Nosy List: David.Johnston, Mariatta, docs@python, python-dev, r.david.murray, terry.reedy
Priority: normal Keywords: easy, patch

Created on 2016-11-04 19:09 by David.Johnston, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
issue28615.patch Mariatta, 2016-11-10 06:45 review
Messages (5)
msg280069 - (view) Author: (David.Johnston) Date: 2016-11-04 19:09
Section 5.4: Numeric Types

Second paragraph reads: 
Appending 'j' or 'J' to a numeric literal yields a complex number with a zero real part.

After reading the table following the paragraphs I thought that the sentence needed revised to the following:
Appending 'j' or 'J' to a numeric literal yields a complex number with a zero imaginary part.

Table in same section for complex(re, im) indicates possible required doc change.

But after testing the use of J and complex I see there is no error here, but perhaps a little better clarification would help others reading the information without access to an editor to test against.
msg280075 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2016-11-04 19:38
For anyone who wants to work on this: this is 5.4 of the python2.7 docs.  The wording in the python3 docs (https://docs.python.org/3/library/stdtypes.html#numeric-types-int-float-complex) is much clearer, if someone wants to prepare a backport patch.
msg280490 - (view) Author: Mariatta (Mariatta) * (Python committer) Date: 2016-11-10 06:45
Hi, here is the doc update, to be applied to 2.7 branch.

Please review. Thanks :)
msg280622 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2016-11-11 23:57
I don't like the term 'imaginary number' but the usage is standard, and python does not have 'complex literals' (I checked 2.7 chapter 2 on number literals).  So I will apply this.
msg280624 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2016-11-12 00:10
New changeset f8d12cb7d0fd by Terry Jan Reedy in branch '2.7':
Issue #28615: Backport imaginary/complex number text from 3.x.
https://hg.python.org/cpython/rev/f8d12cb7d0fd
History
Date User Action Args
2022-04-11 14:58:39adminsetgithub: 72801
2016-11-12 00:10:40terry.reedysetstatus: open -> closed
resolution: fixed
stage: commit review -> resolved
2016-11-12 00:10:04python-devsetnosy: + python-dev
messages: + msg280624
2016-11-11 23:58:07terry.reedysetstage: needs patch -> commit review
2016-11-11 23:57:58terry.reedysetassignee: docs@python -> terry.reedy

messages: + msg280622
nosy: + terry.reedy
2016-11-10 06:45:01Mariattasetfiles: + issue28615.patch

nosy: + Mariatta
messages: + msg280490

keywords: + patch
2016-11-07 15:56:24berker.peksagsetstatus: closed -> open
type: behavior
2016-11-04 19:38:57r.david.murraysetstatus: open -> closed

versions: + Python 2.7
keywords: + easy
nosy: + r.david.murray

messages: + msg280075
stage: needs patch
2016-11-04 19:09:32David.Johnstoncreate