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

Skip to content

Commit 5243695

Browse files
jeromefvjeromefv
committed
Terminology clarification for Figure, Axes, Artist
changed style_guide.rst
1 parent 0be5ffc commit 5243695

File tree

1 file changed

+86
-14
lines changed

1 file changed

+86
-14
lines changed

‎doc/devel/style_guide.rst

Lines changed: 86 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -21,28 +21,100 @@ Terminology
2121
-----------
2222

2323
There are several key terms in Matplotlib that are standards for
24-
reliability and consistency in documentation. They are case-sensitive and are
25-
not interchangeable.
24+
reliability and consistency in documentation. They are not interchangeable.
2625

2726
+------------------+--------------------------+--------------+--------------+
2827
| Term | Description | Correct | Incorrect |
2928
+==================+==========================+==============+==============+
30-
| Figure_ | Matplotlib working space | - One Figure | - One figure |
31-
| | for programming. | - 11 Figures | - 11 figures |
29+
| Figure_ | Matplotlib working space | - *For | - "The figure|
30+
| | for programming. | Matplotlib | is the |
31+
| | | objects*: | working |
32+
| | | Figure, | space for |
33+
| | | "The Figure| visuals." |
34+
| | | is the | - "Methods in|
35+
| | | working | the Figure |
36+
| | | space for | provide the|
37+
| | | the visual.| visuals." |
38+
| | | - *Referring | - "The |
39+
| | | to class*: | Figure_ on |
40+
| | | Figure_ , | the page is|
41+
| | | "Methods | static." |
42+
| | | within the | |
43+
| | | Figure_ | |
44+
| | | provide the| |
45+
| | | visuals." | |
46+
| | | - *General | |
47+
| | | objects*: | |
48+
| | | figure, | |
49+
| | | "All of the| |
50+
| | | figures for| |
51+
| | | this page | |
52+
| | | are | |
53+
| | | static." | |
3254
+------------------+--------------------------+--------------+--------------+
33-
| Axes_ | Subplots within Figure. | - One Axes | - One axes |
34-
| | Contains plot elements | - Four Axes | - Four Axeses|
35-
| | and is responsible for | - 32 Axes | - 32 Axii |
36-
| | plotting and configuring | | |
37-
| | additional details. | | |
55+
| Axes_ | Subplots within Figure. | - *For | - "The axes |
56+
| | Contains plot elements | Matplotlib | methods |
57+
| | and is responsible for | objects*: | transform |
58+
| | plotting and configuring | Axes, "An | the data." |
59+
| | additional details. | Axes is a | - "Each Axes_|
60+
| | | subplot | is specific|
61+
| | | within the | to a |
62+
| | | Figure." | Figure." |
63+
| | | - *Referring | - "All of the|
64+
| | | to class*: | Axes are |
65+
| | | Axes_ , | compatible |
66+
| | | "Each Axes_| with other |
67+
| | | is specific| libraries."|
68+
| | | to one | |
69+
| | | Figure." | |
70+
| | | - *General | |
71+
| | | objects*: | |
72+
| | | axes, "Both| |
73+
| | | explicit | |
74+
| | | and | |
75+
| | | implicit | |
76+
| | | strategies | |
77+
| | | contain | |
78+
| | | multiple | |
79+
| | | types of | |
80+
| | | data | |
81+
| | | visuals | |
82+
| | | on a single| |
83+
| | | axes." | |
3884
+------------------+--------------------------+--------------+--------------+
39-
| Artist_ | Broad variety of | - One Artist | - One artist |
40-
| | Matplotlib objects that | - Two Artists| - Two artists|
41-
| | display visuals. | | |
85+
| Artist_ | Broad variety of | - *For | - "Configure |
86+
| | Matplotlib objects that | Matplotlib | the legend |
87+
| | display visuals. | objects*: | artist with|
88+
| | | Artist, | its |
89+
| | | "Artists | respective |
90+
| | | display | method." |
91+
| | | visuals and| - "There are |
92+
| | | are the | many |
93+
| | | visible | Artists_ in|
94+
| | | elements | this |
95+
| | | when the | graph." |
96+
| | | rendering | - "Some |
97+
| | | a Figure." | Artists |
98+
| | | - *Referring | have an |
99+
| | | to class*: | overlapping|
100+
| | | Artist_ , | naming |
101+
| | | "Each | convention |
102+
| | | Artist_ has| in both |
103+
| | | respective | explicit |
104+
| | | methods and| and |
105+
| | | functions."| implicit |
106+
| | | - *General | uses." |
107+
| | | objects*: | |
108+
| | | artist, | |
109+
| | | "The | |
110+
| | | artists in | |
111+
| | | this table | |
112+
| | | generate | |
113+
| | | visuals." | |
42114
+------------------+--------------------------+--------------+--------------+
43115
| Axis_ | Human-readable single | - One Axis | - One Axis |
44-
| | dimensional object | object | - One axis |
45-
| | of reference marks | - Four Axis | - Four Axises|
116+
| | dimensional object | object | - One axes |
117+
| | of reference marks | - Four axis | - Four Axises|
46118
| | containing ticks, tick | objects | - 32 Axes |
47119
| | labels, spines, and | - 32 Axis | |
48120
| | edges. | objects | |

0 commit comments

Comments
 (0)