@@ -935,7 +935,7 @@ Two best practices for examples are:
935
935
and checking the output. If the example fails, it should be easy to identify and fix the issue.
936
936
- **Making the example usable in multiple contexts **: Ensures that the example can be
937
937
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.
939
939
940
940
Providing a template
941
941
~~~~~~~~~~~~~~~~~~~~
@@ -980,11 +980,11 @@ Making the example usable in multiple contexts
980
980
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
981
981
982
982
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
984
984
them for the web, or by engineers verifying their correctness and updating them. Achieving this
985
985
flexibility requires a careful balance between accessibility, structure, and maintainability.
986
986
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
988
988
Python scripts, but using `Jupytext <https://jupytext.readthedocs.io/en/latest/ >`_ to treat those
989
989
scripts as notebooks when needed. Formatting your examples using the
990
990
`light format <https://jupytext.readthedocs.io/en/latest/formats-scripts.html#the-light-format >`_
0 commit comments