-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
[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
Conversation
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 |
Co-authored-by: Jody Klymak <[email protected]>
03d16a4
to
88863e1
Compare
|
||
API: | ||
|
||
- `~.pyplot.subplots`: create Figure and Axes | ||
- :mod:`~matplotlib.axes`: add data, limits, labels etc. | ||
- `.Figure`: for figure-level methods | ||
|
||
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ | ||
|
||
Example: |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
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.