Skip to content

Commit 847d825

Browse files
committed
Fix missing xref
1 parent 733b587 commit 847d825

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -90,9 +90,15 @@ Independently of the approach you choose, the first step is to fork the Python P
9090

9191
*__TODO__: This section should describe how review happens in GitHub, how see the comments, and how to submit changes (push a new branch)*
9292

93-
## If you need help
93+
## Additional help
9494

95-
*__TODO__: This section should describe the options for finding more help in case beginner contributors need more help (e.g., create an issue, post in a forum, etc). It should also include links to beginner documentation, like the GitHub docs.*
95+
### How to get help
96+
97+
*__TODO__: This section should describe the options for finding more help in case beginner contributors need more help (e.g., create an issue, post in a forum, etc).*
98+
99+
### Additional resources
100+
101+
*__TODO__: It should also include links to beginner documentation, like the GitHub docs.*
96102

97103
## Annex
98104

@@ -101,6 +107,7 @@ Independently of the approach you choose, the first step is to fork the Python P
101107
This guide uses the [literalinclude Sphinx directive](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-literalinclude)
102108
whenever possible to keep code and prose separate. Code for use in the documentation is kept in the `examples/` folder.
103109

110+
(referencing-code-in-documentation)=
104111
#### Referencing code in documentation
105112

106113
If an example is present elsewhere in the documentation that you want to use, you can copy the `literalinclude`
@@ -115,8 +122,9 @@ later can protect your example from future modifications to the code.
115122
`:end-at:` options. And if the example code is Python, `:pyobject:` can be an even more future-proof way to keep the
116123
same documentation content even through code refactors.
117124

118-
If you need example code that doesn't yet exist in `examples/` [see creating code for documentation](#creating-code-for-documentation).
125+
If you need example code that doesn't yet exist in `examples/` see creating code for documentation](#creating-code-for-documentation).
119126

127+
(creating-code-for-documentation)=
120128
#### Creating code for documentation
121129

122130
Whenever you come across a place that could benefit from a code block, instead of writing it in-line with a code fence

0 commit comments

Comments
 (0)