Skip to content

docs: consolidate interactive prompt guidance (#1135) #1924

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

Draft
muhammad-a-dev wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: consolidate interactive prompt guidance (#1135) #1924

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions documentation/markup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -617,6 +617,8 @@ There is also a generic version of these directives:
Describes a Python bytecode instruction.


.. _showing-code-examples:

Showing code examples
---------------------

Expand All @@ -634,6 +636,9 @@ be no trailing prompt. An example of correct usage is:
>>> 1 + 1
2
Style guidance for when to use secondary prompts, and related copy-and-paste
notes, lives under :ref:`code-examples` in the style guide.

Syntax highlighting is handled in a smart way:

* There is a "highlighting language" for each source file. By default,
Expand Down
18 changes: 13 additions & 5 deletions documentation/style-guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,11 +350,19 @@ a typical use case. For instance, the :meth:`str.rpartition` method is better
demonstrated with an example splitting the domain from a URL than it would be
with an example of removing the last word from a line of Monty Python dialog.

The ellipsis for the :py:data:`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.
When writing interactive examples, keep prompt style consistent and copy-friendly:

* Use the ellipsis for the :py:data:`sys.ps2` secondary interpreter prompt only
sparingly, where it is necessary to clearly differentiate between input lines
and output lines. Besides contributing visual clutter, it makes it harder for
readers to copy-and-paste examples so they can experiment with variations.
(Published docs also offer a copy control on interactive examples that strips
prompts for pasting.)
* After the last line of input or output, do not leave a trailing unused primary
prompt (``>>>``).

For the reST markup used to present interactive sessions, see
:ref:`showing-code-examples`.


Code equivalents
Expand Down