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: Tutorial section on starting python is out of date
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.4, Python 3.5
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Israfil, docs@python, eric.araujo, matrixise, python-dev, r.david.murray
Priority: normal Keywords: patch

Created on 2014-03-09 15:45 by r.david.murray, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
issue_20874.patch Israfil, 2014-04-14 18:22 issue_20874 patch review
issue_20874_2.patch Israfil, 2014-04-14 22:12 review
Messages (9)
msg212962 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2014-03-09 15:45
http://docs.python.org/dev/tutorial/interpreter.html does not talk about the fact that completion and history are now enabled by default on systems that support readline, and instead says that the command line editing features are "usually not very sophisticated".  This is no longer true.
msg216155 - (view) Author: Rafael Mejia (Israfil) * Date: 2014-04-14 18:22
Please review that attached patch.  Feedback is welcome.
msg216184 - (view) Author: Stéphane Wirtel (matrixise) * (Python committer) Date: 2014-04-14 19:24
In your patch, you do not explain how to enable the command line editing. Can you add this part, or just add the reference to the existing doc?
msg216212 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2014-04-14 21:00
Just as a point of information, when making a patch like this it is best to change the smallest number of lines possible, without worrying about line wrapping.  This allows us to see just what was changed.  The committer can then reflow the paragraph (actually I prefer to commit the minimum change and then do a separate reflow commit).

The patch itself looks fine.  Stéphane: the original docs didn't explain it either, and in 3.4 you don't have to do anything to enable it.  (That is, if it isn't automatically enabled, it *can't* be turned on, because readline isn't available.)
msg216215 - (view) Author: Stéphane Wirtel (matrixise) * (Python committer) Date: 2014-04-14 21:04
David, thank you for this comment about the automatic activation of the command line editing.
msg216216 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2014-04-14 21:04
Actually I take it back, the patch as a patch also has a couple issues: the line lengths are not in fact less than 80 characters in any case, and there is trailing whitespace on several lines.

Could you redo it with just the minimum lines changed and no trailing whitespace?
msg216234 - (view) Author: Rafael Mejia (Israfil) * Date: 2014-04-14 22:12
I've resubmitted the patch with the minimum lines changed and no trailing white space.
msg216411 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2014-04-16 00:30
New changeset cbe0cf95fe37 by R David Murray in branch '3.4':
#20874: update tutorial wording: sophisticated line editing is now standard.
http://hg.python.org/cpython/rev/cbe0cf95fe37

New changeset b5f4ab357ff9 by R David Murray in branch '3.4':
#20874: reflow paragraph.
http://hg.python.org/cpython/rev/b5f4ab357ff9

New changeset d4e3bea03f9f by R David Murray in branch 'default':
Merge #20874 fix.
http://hg.python.org/cpython/rev/d4e3bea03f9f
msg216412 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2014-04-16 00:31
Thanks, Rafael.
History
Date User Action Args
2022-04-11 14:57:59adminsetgithub: 65073
2014-04-16 00:31:51r.david.murraysetstatus: open -> closed
resolution: fixed
messages: + msg216412

stage: needs patch -> resolved
2014-04-16 00:30:14python-devsetnosy: + python-dev
messages: + msg216411
2014-04-14 22:12:39Israfilsetfiles: + issue_20874_2.patch

messages: + msg216234
2014-04-14 21:04:25r.david.murraysetmessages: + msg216216
2014-04-14 21:04:07matrixisesetmessages: + msg216215
2014-04-14 21:00:22r.david.murraysetmessages: + msg216212
2014-04-14 19:24:00matrixisesetnosy: + matrixise
messages: + msg216184
2014-04-14 18:22:58Israfilsetfiles: + issue_20874.patch

nosy: + Israfil
messages: + msg216155

keywords: + patch
2014-03-15 02:04:16eric.araujosetnosy: + eric.araujo
2014-03-09 15:45:32r.david.murraycreate