You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+11-3Lines changed: 11 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -90,9 +90,15 @@ Independently of the approach you choose, the first step is to fork the Python P
90
90
91
91
*__TODO__: This section should describe how review happens in GitHub, how see the comments, and how to submit changes (push a new branch)*
92
92
93
-
## If you need help
93
+
## Additional help
94
94
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.*
96
102
97
103
## Annex
98
104
@@ -101,6 +107,7 @@ Independently of the approach you choose, the first step is to fork the Python P
101
107
This guide uses the [literalinclude Sphinx directive](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-literalinclude)
102
108
whenever possible to keep code and prose separate. Code for use in the documentation is kept in the `examples/` folder.
103
109
110
+
(referencing-code-in-documentation)=
104
111
#### Referencing code in documentation
105
112
106
113
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.
115
122
`:end-at:` options. And if the example code is Python, `:pyobject:` can be an even more future-proof way to keep the
116
123
same documentation content even through code refactors.
117
124
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).
119
126
127
+
(creating-code-for-documentation)=
120
128
#### Creating code for documentation
121
129
122
130
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