Movatterモバイル変換


[0]ホーム

URL:


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

Sign up
Appearance settings

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

Merged
timhoffm merged 1 commit intomatplotlib:masterfromanntzer:dtk
Sep 7, 2021

Conversation

anntzer
Copy link
Contributor

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

  • Has pytest style unit tests (andpytest passes).
  • IsFlake 8 compliant (runflake8 on changed files to check).
  • New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs shouldbuild without error).
  • Conforms to Matplotlib style conventions (installflake8-docstrings and runflake8 --docstring-convention=all).
  • New features have an entry indoc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented indoc/api/next_api_changes/ (follow instructions in README.rst there).

*******

The mplot3d toolkit adds simple 3D plotting capabilities (scatter, surface,
line, mesh, etc.) to Matplotlib by supplying an axes object that can create
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
line, mesh, etc.) to Matplotlib by supplying anaxes object that can create
line, mesh, etc.) to Matplotlib by supplying anAxes object that can create

Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

sure

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.
Copy link
Member

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?

Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

reworded

@anntzeranntzer marked this pull request as ready for reviewSeptember 6, 2021 05:24
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.
@timhoffmtimhoffm merged commitcb17118 intomatplotlib:masterSep 7, 2021
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull requestSep 7, 2021
@anntzeranntzer deleted the dtk branchSeptember 7, 2021 16:27
dstansby added a commit that referenced this pull requestSep 7, 2021
…003-on-v3.5.xBackport PR#21003 on branch v3.5.x (Deemphasize mpl_toolkits in API docs.)
tacaswell pushed a commit that referenced this pull requestOct 20, 2021
Deemphasize mpl_toolkits in API docs.
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@story645story645story645 left review comments

@timhoffmtimhoffmtimhoffm approved these changes

Assignees
No one assigned
Projects
None yet
Milestone
v3.5.0
Development

Successfully merging this pull request may close these issues.

3 participants
@anntzer@story645@timhoffm

[8]ページ先頭

©2009-2025 Movatter.jp