DOC: update outdated examples/api directory reference#31938
DOC: update outdated examples/api directory reference#31938vishrutakrishnamoorthy-ai wants to merge 2 commits into
Conversation
|
Thank you for opening your first PR into Matplotlib! If you have not heard from us in a week or so, please leave a new comment below and that should bring it to our attention. Most of our reviewers are volunteers and sometimes things fall through the cracks. We also ask that you please finish addressing any review comments on this PR and wait for it to be merged (or closed) before opening a new one, as it can be a valuable learning experience to go through the review process. You can also join us on discourse chat for real-time discussion. For details on testing, writing docs, and our review process, please see the developer guide. We strive to be a welcoming and open project. Please follow our Code of Conduct. |
rcomer
left a comment
There was a problem hiding this comment.
Thanks @vishrutakrishnamoorthy-ai I have one small suggestion and you will also need to fix the linting error.
The easiest way to address linting problems is to install the pre-commit hooks.
https://matplotlib.org/devdocs/devel/development_setup.html#install-pre-commit-hooks
Co-authored-by: Ruth Comer <10599679+rcomer@users.noreply.github.com>
|
Since it has been a week and the change is tiny, I took the liberty of pushing a commit with my suggestion and to fix the linting. Perhaps another maintainer can confirm this looks OK. |
|
I think this doesn't quite cut it.
The distinction in api_interfaces is between the "explicit Axes interface" and the "implicit pyplot interface". This primarily boils down to "the Matplotlib API" is too vague. Possibly the intention is something like
The backgorund is that pyplot manages the window and eventloop, and that a GUI app wants to do this as well. But there are also two funky examples (pyplot with GTK3/4), where the control is still left with pyplot, and we instead hack into the pyplot-managed window to extend it 🤯. I see two options:
I'm leaning towards 2, since the gallery overview is not the place for coding specifics. Unforuntately we don't have a good place where the fundamental GUI pattern is explained. - There's more to it than just Edit: Let's do it like this: Do 1. as an incremental improvement and create a follow-up issue for 2, which will remove the paragraph from the overview. |
Fixes #31935
Replaced the outdated reference to the examples/api directory, which no longer exists, with a reference to the API interfaces documentation.