Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 1346731

Browse files
committed
Add initial guidelines for example tags
1 parent b8950e1 commit 1346731

2 files changed

Lines changed: 20 additions & 1 deletion

File tree

docs/dev_guide/contents/example_gallery.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,22 @@ Contribution Guidelines
4747
* If you need to use ``astropy.visualization.{quantity_support, time_support}``, import these functions at the top of the example, and call them directly before the first plot that needs them.
4848

4949
We recommend checking the other examples in the gallery to see how they are structured and what they contain.
50+
51+
Tagging Examples
52+
================
53+
54+
All our examples in the gallery are tagged with one or more tags describing what topics the example covers.
55+
A list of tags looks like this::
56+
57+
# sphinx_gallery_tags = ["Map", "Coordinates", "AIA"]
58+
59+
The tags we add to examples are:
60+
61+
* Instruments or sources of any data used i.e. ``"AIA", "EUVI", "ADAPT"``.
62+
* Category of SunPy functionality i.e. ``"Map", "Timeseries", "Coordinates", "Reproject"``.
63+
* Data provider where appropriate i.e. ``"JSOC", "HEK"`` these should be the focus of an example.
64+
* Science topic, such as ``"Flares", "Active Regions"``.
65+
* ``"Visualization"`` should be added to examples where the focus of the example is learning visualization techniques.
66+
67+
Tags should be formatted to be human readable, so should be Title Case and make use of symbols such as ``&``.
68+
Adding a tag which hasn't already been added should be done thoughtfully.

examples/acquiring_data/querying_and_loading_SHARP_data.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
66
In this example we will demonstrate how to acquire `Spaceweather HMI Active Region Patch (SHARP) <http://jsoc.stanford.edu/doc/data/hmi/sharp/sharp.htm>`__ data and load it into a `sunpy.map.Map`.
77
"""
8-
# sphinx_gallery_tags = ["Acquiring Data", "JSOC", "Map", "Active Regions", "HMI"]
8+
# sphinx_gallery_tags = ["Acquiring Data", "JSOC", "Map", "Active Regions", "HMI", "SHARP"]
99

1010
import os
1111

0 commit comments

Comments
 (0)