Skip to content

Commit bad4883

Browse files
committed
Changed examples in style_guide.rst
correct/incorrect for Figure, Axes, Artist, Axis
1 parent 3787348 commit bad4883

File tree

1 file changed

+87
-57
lines changed

1 file changed

+87
-57
lines changed

doc/devel/style_guide.rst

+87-57
Original file line numberDiff line numberDiff line change
@@ -32,25 +32,25 @@ reliability and consistency in documentation. They are not interchangeable.
3232
| | | Figure, | space for |
3333
| | | "The Figure| visuals." |
3434
| | | is the | - "Methods in|
35-
| | | working | the Figure |
35+
| | | working | the figure |
3636
| | | space for | provide the|
3737
| | | the visual.| visuals." |
3838
| | | - *Referring | - "The |
39-
| | | to class*: | Figure_ on |
40-
| | | Figure_ , | the page is|
41-
| | | "Methods | static." |
42-
| | | within the | |
43-
| | | Figure_ | |
39+
| | | to class*: | Figure_ |
40+
| | | Figure_ , | Four |
41+
| | | "Methods | leglock is |
42+
| | | within the | a wrestling|
43+
| | | Figure_ | move." |
4444
| | | provide the| |
4545
| | | visuals." | |
4646
| | | - *General | |
47-
| | | objects*: | |
47+
| | | language*: | |
4848
| | | figure, | |
49-
| | | "All of the| |
50-
| | | figures for| |
51-
| | | this page | |
52-
| | | are | |
53-
| | | static." | |
49+
| | | "Michelle | |
50+
| | | Kwan is a | |
51+
| | | famous | |
52+
| | | figure | |
53+
| | | skater." | |
5454
+------------------+--------------------------+--------------+--------------+
5555
| Axes_ | Subplots within Figure. | - *For | - "The axes |
5656
| | Contains plot elements | Matplotlib | methods |
@@ -60,64 +60,94 @@ reliability and consistency in documentation. They are not interchangeable.
6060
| | | subplot | is specific|
6161
| | | within the | to a |
6262
| | | 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| |
63+
| | | - *Referring | - "The |
64+
| | | to class*: | musicians |
65+
| | | Axes_ , | on stage |
66+
| | | "Each Axes_| call their |
67+
| | | is specific| guitars |
68+
| | | to one | Axes." |
69+
| | | Figure." | - "The point |
70+
| | | - *General | where the |
71+
| | | language*: | Axes meet |
72+
| | | axes, "Both| is the |
73+
| | | loggers and| origin of |
74+
| | | lumberjacks| the |
75+
| | | use axes to| coordinate |
76+
| | | chop wood."| system." |
77+
| | | OR "There | |
78+
| | | are no | |
79+
| | | standard | |
80+
| | | names for | |
81+
| | | the | |
82+
| | | coordinates| |
83+
| | | in the | |
84+
| | | three | |
8385
| | | axes." | |
86+
| | | (Plural of | |
87+
| | | axis) | |
8488
+------------------+--------------------------+--------------+--------------+
8589
| Artist_ | Broad variety of | - *For | - "Configure |
8690
| | Matplotlib objects that | Matplotlib | the legend |
8791
| | display visuals. | objects*: | artist with|
8892
| | | Artist, | its |
8993
| | | "Artists | respective |
9094
| | | display | method." |
91-
| | | visuals and| - "There are |
92-
| | | are the | many |
93-
| | | visible | Artists_ in|
94-
| | | elements | this |
95-
| | | when the | graph." |
95+
| | | visuals and| - "There is |
96+
| | | are the | an Artist_ |
97+
| | | visible | for that |
98+
| | | elements | visual in |
99+
| | | when the | the graph."|
96100
| | | rendering | - "Some |
97101
| | | 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*: | |
102+
| | | - *Referring | became |
103+
| | | to class*: | famous only|
104+
| | | Artist_ , | by |
105+
| | | "Each | accident." |
106+
| | | Artist_ has| |
107+
| | | respective | |
108+
| | | methods and| |
109+
| | | functions."| |
110+
| | | - *General | |
111+
| | | language*: | |
108112
| | | artist, | |
109113
| | | "The | |
110-
| | | artists in | |
111-
| | | this table | |
112-
| | | generate | |
113-
| | | visuals." | |
114+
| | | artist in | |
115+
| | | the museum | |
116+
| | | is from | |
117+
| | | France." | |
114118
+------------------+--------------------------+--------------+--------------+
115-
| Axis_ | Human-readable single | - One Axis | - One Axis |
116-
| | dimensional object | object | - One axes |
117-
| | of reference marks | - Four axis | - Four Axises|
118-
| | containing ticks, tick | objects | - 32 Axes |
119-
| | labels, spines, and | - 32 Axis | |
120-
| | edges. | objects | |
119+
| Axis_ | Human-readable single | - *For | - "Plot the |
120+
| | dimensional object | Matplotlib | graph onto |
121+
| | of reference marks | objects*: | the axis." |
122+
| | containing ticks, tick | Axis, "The | - "Each Axis |
123+
| | labels, spines, and | Axis for | is usually |
124+
| | edges. | the bar | named after|
125+
| | | chart is a | the |
126+
| | | separate | coordinate |
127+
| | | Artist." | which is |
128+
| | | (plural, | measured |
129+
| | | Axis | along it." |
130+
| | | objects) | - "In some |
131+
| | | - *Referring | computer |
132+
| | | to class*: | graphics |
133+
| | | Axis_ , | contexts, |
134+
| | | "The Axis_ | the |
135+
| | | contains | ordinate |
136+
| | | respective | Axis_ may |
137+
| | | XAxis and | be oriented|
138+
| | | YAxis | downwards."|
139+
| | | objects." | |
140+
| | | - *General | |
141+
| | | language*: | |
142+
| | | axis, | |
143+
| | | "Rotation | |
144+
| | | around a | |
145+
| | | fixed axis | |
146+
| | | is a | |
147+
| | | special | |
148+
| | | case of | |
149+
| | | rotational | |
150+
| | | motion." | |
121151
+------------------+--------------------------+--------------+--------------+
122152
| Explicit, | Explicit approach of | - Explicit | - object |
123153
| Object Oriented | programing in Matplotlib.| - explicit | oriented |

0 commit comments

Comments
 (0)