classification
Title: IDLE doc improvements
Type: Stage: needs patch
Components: IDLE Versions: Python 3.9, Python 3.8, Python 3.7
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: terry.reedy Nosy List: taleinat, terry.reedy
Priority: normal Keywords:

Created on 2019-08-11 16:54 by terry.reedy, last changed 2019-08-12 04:26 by terry.reedy.

Messages (4)
msg349399 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2019-08-11 16:54
1. Headings: Sections should be titlecased, subsections not.  This is especially needed now that they are not numbered.

2. Python Shell subsection. Revise 'paste', maybe move.  SyntaxWarnings are SyntaxErrors.  Explain Restart.

3. Any other pending changes I include.
msg349427 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2019-08-12 01:44
Because the scope of SyntaxWarnings has been expanded to code that must be run, they should no longer be turned into errors, so this should not be added to the doc.  See #34857.
msg349435 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2019-08-12 04:18
4. Completions subsection: fix this garbled sentence. "Names in an Editor window which are not via __main__ and sys.modules will not be found."  Check 2.6 help.txt from whence it likely came.
msg349436 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2019-08-12 04:26
The garble was in help.txt as copied into idle.rst in #5066.  I will have to figure out the meaning.
History
Date User Action Args
2019-08-12 04:26:09terry.reedysetmessages: + msg349436
2019-08-12 04:18:54terry.reedysetmessages: + msg349435
2019-08-12 01:44:21terry.reedysetmessages: + msg349427
2019-08-11 16:54:19terry.reedycreate