-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
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
Cleanup many docstrings. #16901
Conversation
lib/matplotlib/tri/triinterpolate.py
Outdated
@@ -241,13 +241,13 @@ class LinearTriInterpolator(TriInterpolator): | ||
|
||
Parameters | ||
---------- | ||
triangulation : `~matplotlib.tri.Triangulation` | ||
triangulation : `.Triangulation` |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
thanks, all handled. |
PR Summary
PR Checklist