Deemphasize mpl_toolkits in API docs. #21003
Merged
+29
−96
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
061c109 to
7506a46
Compare
story645
reviewed
Sep 6, 2021
doc/api/toolkits/mplot3d.rst
Outdated
| ******* | ||
|
|
||
| The mplot3d toolkit adds simple 3D plotting capabilities (scatter, surface, | ||
| line, mesh, etc.) to Matplotlib by supplying an axes object that can create |
There was a problem hiding this comment.
Suggested change
| line, mesh, etc.) to Matplotlib by supplying an axes object that can create | |
| line, mesh, etc.) to Matplotlib by supplying an Axes object that can create |
doc/api/toolkits/mplot3d.rst
Outdated
Comment on lines
24
to
25
| mouse up and down. Note that one does not use the zoom button like one | ||
| would use for regular 2D plots. |
There was a problem hiding this comment.
This is unclear - is it tied to the sentence before it?
timhoffm
reviewed
Sep 7, 2021
The docs should present mpl_toolkits as more or less regular modules,
that just happen to live in a different toplevel package for historical
reasons. So just concatenate them to the end of the main module list.
(This is particularly in preparation of the new website redesign, where
the separate "Extra Toolkits" grouping is really too conspicuous on the
front page.)
Remove the toolkits/index page (documenting mplot3d and
axis_grid/axisartist ("ag/aa") together doesn't make much sense except
for this historical grouping), merging the mplot3d intro blurb together
with the one previously at mplot3d/index.rst; the ag/aa blurbs were
just included from the ag/aa API docs themselves and therefore don't
need to be kept.
The mplot3d intro blurb itself can go to the top of the mplot3d API
docs, rather than needing a separate page.
timhoffm
approved these changes
Sep 7, 2021
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Sep 7, 2021
dstansby
added a commit
that referenced
this pull request
Sep 7, 2021
…003-on-v3.5.x Backport PR #21003 on branch v3.5.x (Deemphasize mpl_toolkits in API docs.)
tacaswell
pushed a commit
that referenced
this pull request
Oct 20, 2021
Deemphasize mpl_toolkits in API docs.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The docs should present mpl_toolkits as more or less regular modules,
that just happen to live in a different toplevel package for historical
reasons. So just concatenate them to the end of the main module list.
(This is particularly in preparation of the new website redesign, where
the separate "Extra Toolkits" grouping is really too conspicuous on the
front page.)
Remove the toolkits/index page (documenting mplot3d and
axis_grid/axisartist ("ag/aa") together doesn't make much sense except
for this historical grouping), merging the mplot3d intro blurb together
with the one previously at mplot3d/index.rst; the ag/aa blurbs were
just included from the ag/aa API docs themselves and therefore don't
need to be kept.
The mplot3d intro blurb itself can go to the top of the mplot3d API
docs, rather than needing a separate page.
PR Summary
PR Checklist
pytestpasses).flake8on changed files to check).flake8-docstringsand runflake8 --docstring-convention=all).doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).