Skip to content

Commit 996c22f

Browse files
Apply suggestions from code review
Co-authored-by: Roberto Pastor Muela <[email protected]>
1 parent a99dff4 commit 996c22f

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

doc/source/how-to/documenting.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -935,7 +935,7 @@ Two best practices for examples are:
935935
and checking the output. If the example fails, it should be easy to identify and fix the issue.
936936
- **Making the example usable in multiple contexts**: Ensures that the example can be
937937
usable by a user reading the documentation, an application engineer using the library
938-
through a Notebook, or a developer including the example to the documentation.
938+
through a notebook, or a developer including the example to the documentation.
939939

940940
Providing a template
941941
~~~~~~~~~~~~~~~~~~~~
@@ -980,11 +980,11 @@ Making the example usable in multiple contexts
980980
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
981981

982982
A core objective when designing examples is to ensure they can be used seamlessly across multiple
983-
contexts: whether it's by end users exploring them interactively, by documentation tools rendering
983+
contexts: whether it is by end users exploring them interactively, by documentation tools rendering
984984
them for the web, or by engineers verifying their correctness and updating them. Achieving this
985985
flexibility requires a careful balance between accessibility, structure, and maintainability.
986986

987-
To support this goal, we recommend a workflow where examples are authored and maintained as plain
987+
A recommended approach to support this goal is to author and maintain examples as plain
988988
Python scripts, but using `Jupytext <https://jupytext.readthedocs.io/en/latest/>`_ to treat those
989989
scripts as notebooks when needed. Formatting your examples using the
990990
`light format <https://jupytext.readthedocs.io/en/latest/formats-scripts.html#the-light-format>`_

0 commit comments

Comments
 (0)