Skip to content

DOC: Add section on translating between Axes and pyplot interface #29272

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

Merged
merged 1 commit into from
Dec 11, 2024

Conversation

timhoffm
Copy link
Member

@timhoffm timhoffm commented Dec 9, 2024

No description provided.

@github-actions github-actions bot added the Documentation: user guide files in galleries/users_explain or doc/users label Dec 9, 2024
@story645
Copy link
Member

Can you add a link from the quickstart guide: https://matplotlib.org/devdocs/users/explain/quick_start.html#the-explicit-and-the-implicit-interfaces

am also kinda thinking this could be merged into/replace that section, b/c I think the break down here is a bit better suited to a new to all this audience and the text here isn't particularly figure oriented.

@timhoffm
Copy link
Member Author

timhoffm commented Dec 10, 2024

Disclaimer: This PR is a quick writedown of the comparison/translation between the two styles. It has been bogged a long time that we have no proper description of it in the documentation, and I wanted to get this out of my head.

Can you add a link from the quickstart guide

The quickstart guide already has a link to the top of the API/interfaces page. IMHO this is good enough for now.

this could be merged into/replace that section,

I agree that the quickstart guide can be improved wrt to this topic. However, (i) IMHO the text I've written belongs fundamentally into the API/Interface page, The quickstart guide may reference and or replicate the translation.

The quickstart guide also mentions unmanaged figures, a topic Tom propsed above. IMHO this should be completely stripped from the quickstart guide and put here, because it's an advanced topic.

But this all is beyond my scope for this PR. I do not have the time to substantially rewrite the quickstart guide or the interface explanation. If you want, we can collect the ideas in an issue.

@tacaswell tacaswell added this to the v3.10.0-doc milestone Dec 11, 2024
@timhoffm timhoffm merged commit 7405482 into matplotlib:main Dec 11, 2024
21 checks passed
@timhoffm timhoffm deleted the doc-interface-translate branch December 11, 2024 13:53
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Dec 11, 2024
Copy link

lumberbot-app bot commented Dec 11, 2024

Something went wrong ... Please have a look at my logs.

It seems that the branch you are trying to backport to does not exist.

@timhoffm
Copy link
Member Author

Discussed further improvements are tracked in #29282.

timhoffm added a commit that referenced this pull request Dec 11, 2024
…272-on-v3.10.x

Backport PR #29272 on branch v3.10.x (DOC: Add section on translating between Axes and pyplot interface)
@QuLogic QuLogic modified the milestones: v3.10.0-doc, v3.10.0 Dec 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation: user guide files in galleries/users_explain or doc/users
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants