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
-29Lines changed: 0 additions & 29 deletions
Original file line number
Diff line number
Diff line change
@@ -44,32 +44,3 @@ Note: Tagging organization aims to work for 80-90% of cases. Some examples fall
44
44
How to tag?
45
45
-----------
46
46
Put each tag as a directive at the bottom of the page.
47
-
48
-
Related content
49
-
---------------
50
-
51
-
What is a gallery example?
52
-
^^^^^^^^^^^^^^^^^^^^^^^^^^
53
-
54
-
The gallery of examples contains visual demonstrations of matplotlib features. Gallery examples exist so that users can scan through visual examples.
55
-
56
-
Unlike tutorials or user guides, gallery examples teach by demonstration, rather than by explanation or instruction.
57
-
58
-
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.
59
-
60
-
Format
61
-
^^^^^^
62
-
63
-
All :ref:`examples-index` should aim to follow the following format:
64
-
65
-
* Title: 1-6 words, descriptive of content
66
-
* Subtitle: 10-50 words, action-oriented description of the example subject
67
-
* Image: a clear demonstration of the subject, showing edge cases and different applications if possible
68
-
* Code + Text (optional): code, commented as appropriate + written text to add context if necessary
69
-
70
-
Example:
71
-
72
-
The ``bbox_intersect`` gallery example demonstrates the point of visual examples:
73
-
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