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

Skip to content

Commit 2ae0421

Browse files
esibingamelissawm
andauthored
Apply suggestions from code review
Co-authored-by: Melissa Weber Mendonça <[email protected]>
1 parent ad4dee2 commit 2ae0421

File tree

2 files changed

+12
-14
lines changed

2 files changed

+12
-14
lines changed

galleries/examples/tag_glossary.rst

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
Tag Glossary
44
============
55

6-
I. API tags: what content from the API reference is in the example?
7-
II. Structural tags: what format is the example? What context can we provide?
8-
III. Domain tags: what discipline(s) might seek this example consistently?
9-
IV. Internal tags: what information is helpful for maintainers or contributors?
6+
I. API tags: what content from the API reference is in the example?
7+
II. Structural tags: what format is the example? What context can we provide?
8+
III. Domain tags: what discipline(s) might seek this example consistently?
9+
IV. Internal tags: what information is helpful for maintainers or contributors?
1010

1111

1212
*1. API tags: what content from the API reference is in the example?*
@@ -156,8 +156,6 @@ Note: it's futile to draw fences around "who owns what", and that's not the poin
156156
+-------------------------------+----------------------------------------+
157157
|``domain: signal-processing`` | |
158158
+-------------------------------+----------------------------------------+
159-
| | |
160-
+-------------------------------+----------------------------------------+
161159

162160
*4. Internal tags: what information is helpful for maintainers or contributors?*
163161

galleries/examples/tag_guidelines.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ Guidelines for assigning tags to gallery examples
33

44
*Why do we need tags?*
55

6-
Tags serve multiple purposes.
6+
Tags serve multiple purposes.
77

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.
99

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.
1111

12-
Hidden tags provide additional functionality for maintainers and contributors.
12+
Hidden tags provide additional functionality for maintainers and contributors.
1313

1414
*What gets a tag?*
1515

@@ -33,10 +33,10 @@ IV. Internal tags: what information is helpful for maintainers or contributors?
3333

3434
*Proposing new tags*
3535

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.
4040

4141
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.
4242

0 commit comments

Comments
 (0)