Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
Deemphasize mpl_toolkits in API docs.#21003
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
061c109
to7506a46
Comparedoc/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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
line, mesh, etc.) to Matplotlib by supplying anaxes object that can create | |
line, mesh, etc.) to Matplotlib by supplying anAxes object that can create |
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.
sure
doc/api/toolkits/mplot3d.rst Outdated
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
This is unclear - is it tied to the sentence before it?
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.
reworded
Uh oh!
There was an error while loading.Please reload this page.
The docs should present mpl_toolkits as more or less regular modules,that just happen to live in a different toplevel package for historicalreasons. So just concatenate them to the end of the main module list.(This is particularly in preparation of the new website redesign, wherethe separate "Extra Toolkits" grouping is really too conspicuous on thefront page.)Remove the toolkits/index page (documenting mplot3d andaxis_grid/axisartist ("ag/aa") together doesn't make much sense exceptfor this historical grouping), merging the mplot3d intro blurb togetherwith the one previously at mplot3d/index.rst; the ag/aa blurbs werejust included from the ag/aa API docs themselves and therefore don'tneed to be kept.The mplot3d intro blurb itself can go to the top of the mplot3d APIdocs, rather than needing a separate page.
…003-on-v3.5.xBackport PR#21003 on branch v3.5.x (Deemphasize mpl_toolkits in API docs.)
Deemphasize mpl_toolkits in API docs.
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
pytest
passes).flake8
on changed files to check).flake8-docstrings
and 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).