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
Note: it's futile to draw fences around "who owns what", and that's not the point of domain tags. Domain tags help groups of people to privately organize relevant information, and so are not displayed publicly. See below for a list of existing domain tags. If you don't see the one you're looking for and you think it should exist, consider proposing it.
143
146
@@ -157,7 +160,8 @@ Note: it's futile to draw fences around "who owns what", and that's not the poin
Copy file name to clipboardExpand all lines: galleries/examples/tag_guidelines.rst
+15-8Lines changed: 15 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,8 @@
1
1
Guidelines for assigning tags to gallery examples
2
2
=================================================
3
3
4
-
*Why do we need tags?*
4
+
Why do we need tags?
5
+
--------------------
5
6
6
7
Tags serve multiple purposes.
7
8
@@ -11,7 +12,8 @@ They allow for better discoverability, search, and browse functions. They are he
11
12
12
13
Hidden tags provide additional functionality for maintainers and contributors.
13
14
14
-
*What gets a tag?*
15
+
What gets a tag?
16
+
----------------
15
17
16
18
Every gallery example should be tagged with:
17
19
@@ -24,14 +26,15 @@ Tags can repeat existing forms of organization (e.g. an example is in the Animat
24
26
25
27
Tags are helpful to denote particularly good "byproduct" examples. E.g. the explicit purpose of a gallery example might be to demonstrate a colormap, but it's also a good demonstration of a legend. Tag ``legend`` to indicate that, rather than changing the title or the scope of the example.
26
28
27
-
*Tag Categories* - See :doc:`Tag Glossary <tag_glossary>` for a complete list of tags.
29
+
**Tag Categories** - See :doc:`Tag Glossary <tag_glossary>` for a complete list of tags.
28
30
29
31
I. API tags: what content from the API reference is in the example?
30
32
II. Structural tags: what format is the example? What context can we provide?
31
33
III. Domain tags: what discipline(s) might seek this example consistently?
32
34
IV. Internal tags: what information is helpful for maintainers or contributors?
33
35
34
-
*Proposing new tags*
36
+
Proposing new tags
37
+
------------------
35
38
36
39
1. Review existing tag list, looking out for similar entries (i.e. ``axes`` and ``axis``).
37
40
2. If a relevant tag or subcategory does not yet exist, propose it. Each tag is two parts: ``subcategory: tag``. Tags should be one or two words.
@@ -40,20 +43,24 @@ IV. Internal tags: what information is helpful for maintainers or contributors?
40
43
41
44
Note: Tagging organization aims to work for 80-90% of cases. Some examples fall outside of the tagging structure. Niche or specific examples shouldn't be given standalone tags that won't apply to other examples.
42
45
43
-
*How to tag?*
46
+
How to tag?
47
+
-----------
44
48
where you put the directive is where the tag will show
45
49
46
-
**Related content**
50
+
Related content
51
+
---------------
47
52
48
-
*What is a gallery example?*
53
+
What is a gallery example?
54
+
^^^^^^^^^^^^^^^^^^^^^^^^^^
49
55
50
56
The gallery of examples contains visual demonstrations of matplolib features. Gallery examples exist so that users can scan through visual examples.
51
57
52
58
Unlike tutorials or user guides, gallery examples teach by demonstration, rather than by explanation or instruction.
53
59
54
60
Gallery examples should avoid instruction or excessive explanation except for brief clarifying code comments. Instead, they can tag related concepts and/or link to relevant tutorials or user guides.
55
61
56
-
Format:
62
+
Format
63
+
^^^^^^
57
64
58
65
All gallery examples should aim to follow the following format:
0 commit comments