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

Skip to content

Cleanup some mplot3d docstrings. #15735

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
Nov 22, 2019
Merged

Cleanup some mplot3d docstrings. #15735

merged 1 commit into from
Nov 22, 2019

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Nov 20, 2019

  • Remove comment about method not being tested for methods that
    actually do get test coverage.
  • Rewrite set_{x,y,z}scale docstring -- we don't actually support any
    scale other than linear, and the comment about "improving with each
    release" has clearly been untrue. Also remove versionadded note: the
    methods existed before 1.1.0, they were just inherited from the base
    class, and it wasn't better or worse before...
  • Remove versionadded for get_frame_on and set_frame_on, which existed
    even before 1.1.0 (likewise inherited from the base Axes, which has
    the same implementation; the only difference is the docs).
  • Remove comment about fix in future releases in tick_params -- that's
    not different from any other part of the API, and has in fact been
    left unfixed for years.
  • Remove duplicate versionadded info for plot_trisurf.

PR Summary

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

- Remove comment about method not being tested for methods that
  actually do get test coverage.
- Rewrite set_{x,y,z}scale docstring -- we don't actually support any
  scale other than linear, and the comment about "improving with each
  release" has clearly been untrue.  Also remove versionadded note: the
  methods existed before 1.1.0, they were just inherited from the base
  class, and it wasn't better or worse before...
- Remove versionadded for get_frame_on and set_frame_on, which existed
  even before 1.1.0 (likewise inherited from the base Axes, which has
  the same implementation; the only difference is the docs).
- Remove comment about fix in future releases in tick_params -- that's
  not different from any other part of the API, and has in fact been
  left unfixed for years.
- Remove duplicate versionadded info for plot_trisurf.
@timhoffm timhoffm added this to the v3.1.3 milestone Nov 22, 2019
@timhoffm timhoffm merged commit 24caa1b into matplotlib:master Nov 22, 2019
@anntzer anntzer deleted the 3ddocs branch November 23, 2019 10:23
@QuLogic
Copy link
Member

QuLogic commented Dec 25, 2019

@meeseeksdev backport to v3.1.x
@meeseeksdev backport to v3.2.x

meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Dec 25, 2019
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Dec 25, 2019
QuLogic added a commit that referenced this pull request Dec 25, 2019
…735-on-v3.1.x

Backport PR #15735 on branch v3.1.x (Cleanup some mplot3d docstrings.)
QuLogic added a commit that referenced this pull request Dec 25, 2019
…735-on-v3.2.x

Backport PR #15735 on branch v3.2.x (Cleanup some mplot3d docstrings.)
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.

4 participants