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: galleries/examples/tag_guidelines.rst
+8-8Lines changed: 8 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -3,13 +3,13 @@ Guidelines for assigning tags to gallery examples
3
3
4
4
*Why do we need tags?*
5
5
6
-
Tags serve multiple purposes.
6
+
Tags serve multiple purposes.
7
7
8
-
Tags have a one-to-many organization (i.e. one example can have several tags), while the gallery structure requires that examples are placed in only one location. This means tags provide a secondary layer of organization and make the gallery of examples more flexible and more user-friendly.
8
+
Tags have a one-to-many organization (i.e. one example can have several tags), while the gallery structure requires that examples are placed in only one location. This means tags provide a secondary layer of organization and make the gallery of examples more flexible and more user-friendly.
9
9
10
-
They allow for better discoverability, search, and browse functions. They are helpful for users struggling to write a search query for what they're looking for.
10
+
They allow for better discoverability, search, and browse functions. They are helpful for users struggling to write a search query for what they're looking for.
11
11
12
-
Hidden tags provide additional functionality for maintainers and contributors.
12
+
Hidden tags provide additional functionality for maintainers and contributors.
13
13
14
14
*What gets a tag?*
15
15
@@ -33,10 +33,10 @@ IV. Internal tags: what information is helpful for maintainers or contributors?
33
33
34
34
*Proposing new tags*
35
35
36
-
1. Review existing tag list, looking out for similar entries (i.e. ``axes`` and ``axis``).
37
-
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.
38
-
3. New tags should be be added when they are relevant to existing gallery entries too. Avoid tags that will link to only a single gallery entry.
39
-
4. Tags can recreate other forms of organization.
36
+
1. Review existing tag list, looking out for similar entries (i.e. ``axes`` and ``axis``).
37
+
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.
38
+
3. New tags should be be added when they are relevant to existing gallery entries too. Avoid tags that will link to only a single gallery entry.
39
+
4. Tags can recreate other forms of organization.
40
40
41
41
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.
0 commit comments