Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork8.1k
DOC: Reintroduce glossary#30782
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
+45 −0
Merged
Changes fromall commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
44 changes: 44 additions & 0 deletionsdoc/users/glossary.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| ======== | ||
| Glossary | ||
| ======== | ||
| .. Note for glossary authors: | ||
| The glossary is primarily intended for Matplotlib's own concepts and | ||
| terminology, e.g. figure, artist, backend, etc. We don't want to list | ||
| general terms like "GUI framework", "event loop" or similar. | ||
| The glossary should contain a short definition of the term, aiming at | ||
| a high-level understanding. Use links to redirect to more comprehensive | ||
| explanations and API reference when possible. | ||
| This glossary defines concepts and terminology specific to Matplotlib. | ||
| .. glossary:: | ||
| Figure | ||
| The outermost container for a Matplotlib graphic. Think of this as the | ||
| canvas to draw on. | ||
| This is implemented in the class `.Figure`. For more details see | ||
| :ref:`figure-intro`. | ||
| Axes | ||
| This is a container for what is often colloquially called a plot/chart/graph. | ||
| It's a data area with :term:`Axis`\ es, i.e. coordinate directions, | ||
| and includes data artists like lines, bars etc. as well as | ||
| decorations like title, axis labels, legend. | ||
| Since most "plotting operations" are realized as methods on `~.axes.Axes` | ||
| this is the object users will mostly interact with. | ||
| Note: The term *Axes* was taken over from MATLAB. Think of this as | ||
| a container spanned by the *x*- and *y*-axis, including decoration | ||
| and data. | ||
| Axis | ||
| A direction with a scale. The scale defines the mapping from | ||
| data coordinates to screen coordinates. The Axis also includes | ||
| the ticks and axis label. | ||
| Artist | ||
| The base class for all graphical element that can be drawn. | ||
| Examples are Lines, Rectangles, Text, Ticks, Legend, Axes, ... |
1 change: 1 addition & 0 deletionsdoc/users/index.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -103,3 +103,4 @@ Using Matplotlib | ||
| getting_started/index | ||
| ../install/index | ||
| glossary | ||
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.