Skip to content

Don't duplicate docstrings of pyplot-level cmap setters. #17389

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
Jun 23, 2020

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented May 12, 2020

Dynamically generating these docstrings takes ~40us, which is
negligible compared to the import time.

flake8 had to be updated, as older versions incorrectly warned about the
lack of blank lines between the one-liners.

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

Dynamically generating these docstrings takes ~40us, which is
negligible compared to the import time.

flake8 had to be updated, as older versions incorrectly warned about the
lack of blank lines between the one-liners.
@tacaswell tacaswell added this to the v3.4.0 milestone May 12, 2020
@timhoffm
Copy link
Member

3.3 is not yet branched. Either we wait or milestone this for 3.3.

@anntzer
Copy link
Contributor Author

anntzer commented May 12, 2020

I'm not in a hurry.

@jklymak
Copy link
Member

jklymak commented Jun 4, 2020

Doers this need to wait for the branch? Not sure I understand why we don't just merge for 3.3?

@timhoffm
Copy link
Member

timhoffm commented Jun 4, 2020

I'm unclear why azure is failing.

Otherwise we could re-target this to 3.3 and merge.

@QuLogic QuLogic closed this Jun 23, 2020
@QuLogic QuLogic reopened this Jun 23, 2020
@QuLogic QuLogic merged commit 8589fed into matplotlib:master Jun 23, 2020
@anntzer anntzer deleted the cmapdocs branch June 23, 2020 06:21
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.

6 participants