Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Recommend using SI units in documentation #795

Merged
merged 2 commits into from
Jan 21, 2021
Merged

Recommend using SI units in documentation #795

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f75ed71
Add suggestion to use SI units in guidelines; change example to use S…
willschlitzer Jan 21, 2021
71f31c2
Merge branch 'master' into si-units-guidelines
willschlitzer Jan 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,10 +130,11 @@ General guidelines for making a good gallery plot:
dataset isn't available, open an issue requesting one and we'll work together to add
it.
* Add comments to explain things are aren't obvious from reading the code. Good: *Use a
Mercator projection and make the plot 6 inches wide*. Bad: *Draw coastlines and plot
the data*.
Mercator projection and make the plot 15 centimeters wide*. Bad: *Draw coastlines and
plot the data*.
* Describe the feature that you're showcasing and link to other relevant parts of the
documentation.
* SI units should be used in the example code for gallery plots.

### Tutorials

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

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