Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

[DOC] Enhance API reference index #26671

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
Sep 12, 2023

Conversation

timhoffm
Copy link
Member

@timhoffm timhoffm commented Sep 1, 2023

Following up on the discussion in #26623 / #26624, I've tried to make this as informative and concise as possible.

Note: This is a proposal, I'm not wedded to any of the details, and I'm also fine to close if this does not go into the right direction.

grafik

@timhoffm timhoffm added Documentation Documentation: API files in lib/ and doc/api labels Sep 1, 2023
@story645
Copy link
Member

story645 commented Sep 1, 2023

slight bias towards shadow off and I think @jklymak should be added as a coauthor, but I think this is really clean. Also would put the see for detailed at the top -> I think then it can set expectations that this won't be detailed.

Co-authored-by: Jody Klymak <jklymak@gmail.com>
@timhoffm timhoffm force-pushed the suggestion-api-index branch from 03d16a4 to 88863e1 Compare September 1, 2023 12:44

API:

- `~.pyplot.subplots`: create Figure and Axes
- :mod:`~matplotlib.axes`: add data, limits, labels etc.
- `.Figure`: for figure-level methods

+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

Example:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if Example and API need to be explicitly written - I can go either way on this. What I mean is the example and api roadmapping should definitely be here, but I dunno about the title.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Slight preference to keep them. It's more explicit what the sections are about, in particular if you have only a quick glance at it. I think the cards are still compact enough so that we can afford the extra vertical space.

@oscargus oscargus added this to the v3.8.0 milestone Sep 12, 2023
@oscargus oscargus merged commit 221f6c2 into matplotlib:main Sep 12, 2023
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Sep 12, 2023
@timhoffm timhoffm deleted the suggestion-api-index branch September 14, 2023 10:20
@ksunden ksunden mentioned this pull request Sep 15, 2023
5 tasks
@story645 story645 mentioned this pull request Sep 20, 2023
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation: API files in lib/ and doc/api Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
Morty Proxy This is a proxified and sanitized view of the page, visit original site.