@@ -73,13 +73,13 @@ later can protect your example from future modifications to the code.
73
73
` :end-at: ` options. And if the example code is Python, ` :pyobject: ` can be an even more future-proof way to keep the
74
74
same documentation content even through code refactors.
75
75
76
- If you need example code that doesn't yet exist in ` examples/ ` see (#creating-code-for-documentation).
76
+ If you need example code that doesn't yet exist in ` examples/ ` see [ ] ( #creating-code-for-documentation ) .
77
77
78
78
### Creating code for documentation
79
79
80
80
Whenever you come across a place that could benefit from a code block, instead of writing it in-line with a code fence
81
81
(`` ``` `` blocked text) you can write it as a file in its own format. Your example may even already exist; see
82
- (#referencing-code-in-documentation).
82
+ [ ] ( #referencing-code-in-documentation ) .
83
83
84
84
If you need a net new example and it doesn't fit into any existing example files, you can create a new file and
85
85
reference it in a ` literalinclude ` . If it makes sense for that file to live within one of the existing example
@@ -92,7 +92,7 @@ instance, add new functions to the end of the file, new methods after all existi
92
92
Example code is checked for correctness, so adding a new example may require adding additional tests for coverage, and
93
93
will require fixing any failing tests.
94
94
95
- *** WARNING*** : great care should be taken when modifying existing example code, especially any modification beyond
95
+ *** ⚠️ WARNING*** : great care should be taken when modifying existing example code, especially any modification beyond
96
96
appending to the end of the file. All code examples are (potentially) shared examples. This makes for more consistent
97
97
examples in the guide but can mean action-at-a-distance when modifying the examples for one particular use case.
98
98
If you find yourself modifying existing examples try running this command and then checking those pages in a new build.
0 commit comments