classification
Title: For 7.2.7. Code Examples, distinguish between the Tutorial and other documentation
Type: Stage:
Components: Versions: Python 3.10, Python 3.9, Python 3.8, Python 3.7, Python 3.6, Python 3.5
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: Nosy List: Chas Belov
Priority: normal Keywords:

Created on 2020-05-24 20:49 by Chas Belov, last changed 2020-05-24 20:49 by Chas Belov.

Messages (1)
msg369825 - (view) Author: Chas Belov (Chas Belov) * Date: 2020-05-24 20:49
7.2.7. Code Examples https://devguide.python.org/documenting/#code-examples states:

Short code examples can be a useful adjunct to understanding. Readers can often grasp a simple example more quickly than they can digest a formal description in prose.

[snip]

The ellipsis for the sys.ps2 secondary interpreter prompt should only be used sparingly, where it is necessary to clearly differentiate between input lines and output lines. Besides contributing visual clutter, it makes it difficult for readers to cut-and-paste examples so they can experiment with variations.

-----

I am requesting, as a newcomer to Python who is attempting to navigate the Tutorials and encountering challenges, that this be reworded to something like:

Short code examples can be a useful adjunct to understanding. Readers can often grasp a simple example more quickly than they can digest a formal description in prose.

[snip]

Outside of the Tutorial, the ellipsis for the sys.ps2 secondary interpreter prompt should only be used sparingly, where it is necessary to clearly differentiate between input lines and output lines. Besides contributing visual clutter, it makes it difficult for readers to cut-and-paste examples so they can experiment with variations.

Within the Tutorial, however, make the appearance of code blocks as consistent with what the student will be experiencing as feasible, to reduce cognitive load and allow them to focus on the content.

-----

While I can in fact suss out whether a particular unmarked code block is meant to be input or output, it is a distraction that uses up some of my attention that I would prefer to spend on learning the language.
History
Date User Action Args
2020-05-24 20:49:57Chas Belovsetversions: + Python 3.5, Python 3.6, Python 3.7, Python 3.8, Python 3.9
2020-05-24 20:49:25Chas Belovcreate