@@ -73,17 +73,17 @@ 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 ] ( #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
- (`` ``` `` 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 ) .
81
+ (`` ``` `` blocked text) you can write it as a file in its own format. Your example may even already exist; [ see referencing code in documentation
82
+ ] ( #referencing-code-in-documentation ) .
83
83
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
- reference it in a ` literalinclude ` . If it makes sense for that file to live within one of the existing example
86
- projects please add it there; otherwise create a new folder in the examples.
84
+ If you want to add a new example that doesn't fit into any of the existing example files, you can create a new file and
85
+ reference it in a ` literalinclude ` block . If it makes sense for that file to live within one of the existing example
86
+ projects please add it there; otherwise create a new folder in the ` examples ` directory .
87
87
88
88
If an existing example is incomplete or a new example makes sense to be added to an existing file, go ahead and add it,
89
89
but take care to not break the rest of the guide. Whenever possible, extend the example rather that rewrite it. So for
0 commit comments