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

Skip to content

Commit da1551f

Browse files
committed
DOC: Clarify interface terminology
as proposed in https://github .com//issues/21817#issuecomment-983705359 and #26388 and already used in 26402. Closes #21817.
1 parent 69f9ebf commit da1551f

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

doc/devel/style_guide.rst

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -155,14 +155,19 @@ reliability and consistency in documentation. They are not interchangeable.
155155
| | | rotational | |
156156
| | | motion." | |
157157
+------------------+--------------------------+--------------+--------------+
158-
| Explicit, | Explicit approach of | - Explicit | - object |
159-
| Object Oriented | programming in | - explicit | oriented |
160-
| Programming (OOP)| Matplotlib. | - OOP | - OO-style |
158+
| Axes interface | Usage pattern in which | - Axes | - explicit |
159+
| | one calls methods on | interface | interface |
160+
| | Axes and Figure (and | - call | - object |
161+
| | sometimes other Artist) | methods on | oriented |
162+
| | objects to configure the | the Axes / | - OO-style |
163+
| | plot. | Figure | - OOP |
164+
| | | object | |
161165
+------------------+--------------------------+--------------+--------------+
162-
| Implicit, | Implicit approach of | - Implicit | - MATLAB like|
163-
| ``pyplot`` | programming in Matplotlib| - implicit | - Pyplot |
164-
| | with ``pyplot`` module. | - ``pyplot`` | - pyplot |
165-
| | | | interface |
166+
| pyplot interface | Usage pattern in which | - ``pyplot`` | - implicit |
167+
| | one only calls `.pyplot` | interface | interface |
168+
| | functions to configure | - call | - MATLAB like|
169+
| | the plot. | ``pyplot`` | - Pyplot |
170+
| | | functions | |
166171
+------------------+--------------------------+--------------+--------------+
167172

168173
.. |Figure| replace:: :class:`~matplotlib.figure.Figure`

0 commit comments

Comments
 (0)