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

Skip to content

Commit 71f25f4

Browse files
committed
move docs back to devel, updates from review
1 parent ed45c85 commit 71f25f4

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

galleries/examples/tag_glossary.rst renamed to doc/devel/tag_glossary.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ IV. Internal tags: what information is helpful for maintainers or contributors?
3838
|``styling: conditional`` |styling is determined programmatically by a |
3939
| |condition being met |
4040
+-----------------------------------+---------------------------------------------+
41+
|``styling: showcase`` |good showcase example |
42+
+-----------------------------------+---------------------------------------------+
4143
| | |
4244
+-----------------------------------+---------------------------------------------+
4345
|**Primary or relevant plot component** |

galleries/examples/tag_guidelines.rst renamed to doc/devel/tag_guidelines.rst

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,6 @@ Every gallery example should be tagged with:
2020
* 1+ content tags
2121
* structural, domain, or internal tag(s) if helpful
2222

23-
Examples with many tags may indicate that the entry is a showcase example.
24-
2523
Tags can repeat existing forms of organization (e.g. an example is in the Animation folder and also gets an ``animation`` tag).
2624

2725
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
4543

4644
How to tag?
4745
-----------
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.
4947

5048
Related content
5149
---------------
5250

5351
What is a gallery example?
5452
^^^^^^^^^^^^^^^^^^^^^^^^^^
5553

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

5856
Unlike tutorials or user guides, gallery examples teach by demonstration, rather than by explanation or instruction.
5957

@@ -62,7 +60,7 @@ Gallery examples should avoid instruction or excessive explanation except for br
6260
Format
6361
^^^^^^
6462

65-
All gallery examples should aim to follow the following format:
63+
All :ref:`examples-index` should aim to follow the following format:
6664

6765
* Title: 1-6 words, descriptive of content
6866
* 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:
7169

7270
Example:
7371

74-
``bbox_intersect`` gallery example showcases the point of visual examples
72+
The ``bbox_intersect`` gallery example demonstrates the point of visual examples:
7573

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
7775
* https://matplotlib.org/devdocs/gallery/misc/bbox_intersect.html#sphx-glr-gallery-misc-bbox-intersect-py

0 commit comments

Comments
 (0)