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: doc/devel/tag_guidelines.rst
+5-7Lines changed: 5 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -20,8 +20,6 @@ Every gallery example should be tagged with:
20
20
* 1+ content tags
21
21
* structural, domain, or internal tag(s) if helpful
22
22
23
-
Examples with many tags may indicate that the entry is a showcase example.
24
-
25
23
Tags can repeat existing forms of organization (e.g. an example is in the Animation folder and also gets an ``animation`` tag).
26
24
27
25
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.
@@ -45,15 +43,15 @@ Note: Tagging organization aims to work for 80-90% of cases. Some examples fall
45
43
46
44
How to tag?
47
45
-----------
48
-
where you put the directive is where the tag will show
46
+
Put each tag as a directive at the bottom of the page.
49
47
50
48
Related content
51
49
---------------
52
50
53
51
What is a gallery example?
54
52
^^^^^^^^^^^^^^^^^^^^^^^^^^
55
53
56
-
The gallery of examples contains visual demonstrations of matplolib features. Gallery examples exist so that users can scan through visual examples.
54
+
The gallery of examples contains visual demonstrations of matplotlib features. Gallery examples exist so that users can scan through visual examples.
57
55
58
56
Unlike tutorials or user guides, gallery examples teach by demonstration, rather than by explanation or instruction.
59
57
@@ -62,7 +60,7 @@ Gallery examples should avoid instruction or excessive explanation except for br
62
60
Format
63
61
^^^^^^
64
62
65
-
All gallery examples should aim to follow the following format:
63
+
All :ref:`examples-index` should aim to follow the following format:
66
64
67
65
* Title: 1-6 words, descriptive of content
68
66
* Subtitle: 10-50 words, action-oriented description of the example subject
@@ -71,7 +69,7 @@ All gallery examples should aim to follow the following format:
71
69
72
70
Example:
73
71
74
-
``bbox_intersect`` gallery example showcases the point of visual examples
72
+
The ``bbox_intersect`` gallery example demonstrates the point of visual examples:
75
73
76
-
* messy example/ hard to categorize, but the gallery is definitely the right spot for it because it's the kind of thing you'd find by visual search
74
+
* this example is "messy" in that it's hard to categorize, but the gallery is the right spot for it because it makes sense to find it by visual search
0 commit comments