-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
Help page on concepts and mechanisms in matplotlib #9967
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Comments
I think improving the usage guide is a place to start. It has most of your first subsection. http://matplotlib.org/tutorials/introductory/usage.html#sphx-glr-tutorials-introductory-usage-py |
That's indeed a good place, already conating some of my points (though I haven't yet read it completely). Maybe even more important than changing the contents is making this more accessible. To find it from the main page, I had to
Step 1 is fine, I would never have guessed that I have to follow the links in 2 and 3 to find that information. Maybe part of the problem is the naming. It's more a reference than a tutorial. Also, it's more "Concepts/Structure of matplotlib" than a "User Guide". |
Agreed. I think that right now there is no user documentation. The advice I've received is to go ahead and add documentation to the existing structure, which for better or worse is the "tutorials" section, and then a re-organization will happen using that raw material. I think the only caveat there is that tutorials are |
FWIW I believe that although sphinx-gallery is really good for "unstructured" examples where the main focus is sample code and plot, it doesn't work so well for "tutorial/guide" style docs where text is the most important part. |
wonder how much this ties in w/ MEP #17446 |
Wondering if most of this was addressed in #21641 w/ possibly a follow up issue that basically adds an intro to the transform tutorial to the quick-start guide? Or are you looking to make a kinda glossary/single source of truth thing - we had one that was removed in #18696 b/c it just listed backends, but a "core concepts in mpl" might not be bad? A different alternative 'cause search is kinda not great is maybe using something like sphinx-tags to catalog some of the related pages? |
@story645 Thanks for the ping. I'll check what is available now and reconsider what I want here. Will get back on this later. |
This issue has been marked "inactive" because it has been 365 days since the last comment. If this issue is still present in recent Matplotlib releases, or the feature request is still wanted, please leave a comment and this label will be removed. If there are no updates in another 30 days, this issue will be automatically closed, but you are free to re-open or create a new issue if needed. We value issue reports, and this procedure is meant to help us resurface and prioritize issues that have not been addressed yet, not make them disappear. Thanks for your help! |
Keeping this open until we can replace with a more actionable roadmap for doing this in docs? |
Feature request
We do not have a description of the concepts and mechanisms used in matplotlib. Some information is available in the respective classes or in examples. But I haven't found a concise overview giving the big picture.
It would be valuable for users (and also developers) to have a single help page collecting this information.
In particular:
Elements of a plot
Coordinates and scaling
The above are just the topics that came to my mind right now. It's work in progress and I plan to work on this later on. Comments and additions are welcome.
The text was updated successfully, but these errors were encountered: