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

Appearance settings

Cleanup many docstrings. #16901

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
Mar 25, 2020
Merged

Cleanup many docstrings. #16901

merged 1 commit into from
Mar 25, 2020

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Mar 25, 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 Mar 25, 2020
lib/matplotlib/axes/_base.py Outdated Show resolved Hide resolved
@@ -241,13 +241,13 @@ class LinearTriInterpolator(TriInterpolator):

Parameters
----------
triangulation : `~matplotlib.tri.Triangulation`
triangulation : `.Triangulation`
Copy link
Member

Choose a reason for hiding this comment

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

I think we had that topic in another PR lately. This change is against our documentation guide https://matplotlib.org/devel/documenting_mpl.html#referencing-types

Use full references ~matplotlib.colors.Normalize with an abbreviation tilde in parameter types. While the full name helps the reader of plain text docstrings, the HTML does not need to show the full name as it links to it. Hence, the ~-shortening keeps it more readable.

Use abbreviated links .Normalize in the text.

I still think this is a reasonable policy, but we can discuss that if you like. However, I don't want us do act differently from our stated policy.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

let's discuss this separately, I reverted the changes for now.

lib/matplotlib/tri/triinterpolate.py Outdated Show resolved Hide resolved
lib/matplotlib/tri/trirefine.py Outdated Show resolved Hide resolved
lib/matplotlib/tri/trirefine.py Outdated Show resolved Hide resolved
lib/matplotlib/tri/tritools.py Outdated Show resolved Hide resolved
lib/matplotlib/transforms.py Outdated Show resolved Hide resolved
lib/matplotlib/transforms.py Outdated Show resolved Hide resolved
lib/matplotlib/transforms.py Outdated Show resolved Hide resolved
lib/matplotlib/transforms.py Outdated Show resolved Hide resolved
@anntzer
Copy link
Contributor Author

anntzer commented Mar 25, 2020

thanks, all handled.

@timhoffm timhoffm merged commit e7fcb37 into matplotlib:master Mar 25, 2020
@anntzer anntzer deleted the docs branch March 25, 2020 13:47
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.

2 participants
Morty Proxy This is a proxified and sanitized view of the page, visit original site.