Thanks to visit codestin.com
Credit goes to github.com

Skip to content

De-duplicate mplot3D API docs #22061

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
Jan 2, 2022
Merged

Conversation

dstansby
Copy link
Member

PR Summary

There are some API listings in the 3D tutorial that are duplicates of the actual API documentation. Remove these so it's possible to do e.g. `.Axes3D.plot` in sphinx RST without getting a duplicate entry warning.

PR Checklist

Tests and Styling

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

  • New features are documented, with examples if plot related.
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).

@dstansby dstansby force-pushed the mplot3d-dedup-api branch 2 times, most recently from c0b2a4d to 2d30371 Compare December 30, 2021 10:11
@dstansby dstansby changed the title De-duplicated mplot3D API docs De-duplicate mplot3D API docs Dec 30, 2021
@tacaswell tacaswell added this to the v3.6.0 milestone Dec 31, 2021
@@ -44,8 +45,6 @@
:target: ../../gallery/mplot3d/lines3d.html
:align: center

.. automethod:: Axes3D.plot
Copy link
Member

Choose a reason for hiding this comment

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

Do we want to replace these with references rather than just deleting?

Copy link
Member Author

Choose a reason for hiding this comment

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

Good idea 👍

@timhoffm timhoffm merged commit 1708956 into matplotlib:main Jan 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants