Skip to content

DOC: Clarify interface terminology #28025

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
timhoffm merged 1 commit into from
Apr 8, 2024
Merged

DOC: Clarify interface terminology #28025

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions doc/devel/style_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,14 +155,19 @@ reliability and consistency in documentation. They are not interchangeable.
| | | rotational | |
| | | motion." | |
+------------------+--------------------------+--------------+--------------+
| Explicit, | Explicit approach of | - Explicit | - object |
| Object Oriented | programming in | - explicit | oriented |
| Programming (OOP)| Matplotlib. | - OOP | - OO-style |
| Axes interface | Usage pattern in which | - Axes | - explicit |
| | one calls methods on | interface | interface |
| | Axes and Figure (and | - call | - object |
| | sometimes other Artist) | methods on | oriented |
| | objects to configure the | the Axes / | - OO-style |
| | plot. | Figure | - OOP |
| | | object | |
+------------------+--------------------------+--------------+--------------+
| Implicit, | Implicit approach of | - Implicit | - MATLAB like|
| ``pyplot`` | programming in Matplotlib| - implicit | - Pyplot |
| | with ``pyplot`` module. | - ``pyplot`` | - pyplot |
| | | | interface |
| pyplot interface | Usage pattern in which | - ``pyplot`` | - implicit |
| | one only calls `.pyplot` | interface | interface |
| | functions to configure | - call | - MATLAB like|
| | the plot. | ``pyplot`` | - Pyplot |
| | | functions | |
+------------------+--------------------------+--------------+--------------+

.. |Figure| replace:: :class:`~matplotlib.figure.Figure`
Expand Down