Skip to content

Commit

Permalink
Added information about highlighting python console examples in doc.
Browse files Browse the repository at this point in the history
  • Loading branch information
bmispelon committed Apr 27, 2024
1 parent 8c257ce commit 5b6fd5c
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/internals/contributing/writing-documentation.txt
Expand Up @@ -301,6 +301,10 @@ documentation:
syntax, it won't be highlighted. Adding ``.. code-block:: python``, for
example, will force highlighting despite invalid syntax.

* Use ``.. code-block:: pycon`` to highlight code blocks that show examples of
an interactive Python console session, and make sure to include the ``>>> ``
line prefixes in that case.

* To improve readability, use ``.. admonition:: Descriptive title`` rather than
``.. note::``. Use these boxes sparingly.

Expand Down

0 comments on commit 5b6fd5c

Please sign in to comment.