Skip to content

Cleanup colors.py docstrings. #17151

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
May 8, 2020
Merged

Cleanup colors.py docstrings. #17151

merged 2 commits into from
May 8, 2020

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Apr 15, 2020

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

@anntzer anntzer added this to the v3.3.0 milestone Apr 15, 2020
@tacaswell
Copy link
Member 

/home/circleci/project/lib/matplotlib/colors.py:docstring of matplotlib.colors.BoundaryNorm:44: WARNING: py:obj reference target not found: Colormap.__call__

@tacaswell
Copy link
Member

The 3.8 doc build now fails due to not pulling the pytest object inventory, but this change adds several extra __foo__ entries, my attempts to re-exclude them locally are not going great....

@anntzer
Copy link
Contributor Author

anntzer commented Apr 16, 2020

We could just re-exclude __call__ for now, or regen missing-references.json.

@efiring
Copy link
Member

efiring commented May 8, 2020

I think the docs failure is a transient:

WARNING: failed to reach any of the inventories with the following issues:
intersphinx inventory 'https://pytest.org/en/stable/objects.inv' not fetchable due to <class 'requests.exceptions.HTTPError'>: 502 Server Error: Bad Gateway for url: https://pytest.org/en/stable/objects.i
nv

If so, this can be merged.

@anntzer
Copy link
Contributor Author

anntzer commented May 8, 2020

at least it looks so to me.

@efiring efiring merged commit b5fbbb5 into matplotlib:master May 8, 2020
@anntzer anntzer deleted the colordoc branch May 8, 2020 19:23
timhoffm added a commit to timhoffm/matplotlib that referenced this pull request Apr 26, 2021
@timhoffm
Limit documenting special members to __call__
51bc5e5 
Closes matplotlib#20080.

Follow up to matplotlib#17151.
@timhoffm timhoffm mentioned this pull request Apr 26, 2021
Merged
timhoffm added a commit to timhoffm/matplotlib that referenced this pull request Apr 28, 2021
@timhoffm
Limit documenting special members to __call__
4386c2a 
Closes matplotlib#20080.

Follow up to matplotlib#17151.
timhoffm added a commit to timhoffm/matplotlib that referenced this pull request Apr 28, 2021
@timhoffm
Declare sphinxext.redirect_from parallel_read_safe
4d248b2 
This uses a domain as data store for the redirects sphinx plugin.
That is how the sphinx todo extension handles data and was suggested in
sphinx-doc/sphinx#9003 (comment)

Limit documenting special members to __call__

Closes matplotlib#20080.

Follow up to matplotlib#17151.
timhoffm added a commit to timhoffm/matplotlib that referenced this pull request Apr 28, 2021
@timhoffm
Limit documenting special members to __call__
989553e 
Closes matplotlib#20080.

Follow up to matplotlib#17151.
jklymak pushed a commit to jklymak/matplotlib that referenced this pull request Jun 13, 2021
@timhoffm @jklymak
Limit documenting special members to __call__
e9c6c82 
Closes matplotlib#20080.

Follow up to matplotlib#17151.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@efiring efiring efiring approved these changes

Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v3.3.0
Development

Successfully merging this pull request may close these issues.
3 participants
@anntzer @tacaswell @efiring