Skip to content

Commit d99708d

Browse files
Recommend using SI units in documentation (#795)
1 parent bbd84d1 commit d99708d

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

CONTRIBUTING.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -130,10 +130,11 @@ General guidelines for making a good gallery plot:
130130
dataset isn't available, open an issue requesting one and we'll work together to add
131131
it.
132132
* Add comments to explain things are aren't obvious from reading the code. Good: *Use a
133-
Mercator projection and make the plot 6 inches wide*. Bad: *Draw coastlines and plot
134-
the data*.
133+
Mercator projection and make the plot 15 centimeters wide*. Bad: *Draw coastlines and
134+
plot the data*.
135135
* Describe the feature that you're showcasing and link to other relevant parts of the
136136
documentation.
137+
* SI units should be used in the example code for gallery plots.
137138

138139
### Tutorials
139140

@@ -155,6 +156,7 @@ Guidelines for a good tutorial:
155156
features or abbreviations.
156157
* Explain the options and features in as much detail as possible. The gallery has
157158
concise examples while the tutorials are detailed and full of text.
159+
* SI units should be used in the example code for tutorial plots.
158160

159161
Note that the `Figure.show()` function needs to be called for a plot to be inserted into
160162
the documentation.

0 commit comments

Comments
 (0)