[Doc] Improve documentation types #26186
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
db98e70 to
c33bccf
Compare
oscargus
commented
Jun 25, 2023
| @@ -774,7 +774,7 @@ def set_clip_path(self, path, transform=None): | |||
|
|
|||
| Parameters | |||
| ---------- | |||
| path : `.Patch` or `.Path` or `.TransformedPath` or None | |||
| path : `~matplotlib.patches.Patch` or `.Path` or `.TransformedPath` or None | |||
There was a problem hiding this comment.
Yes, this one can be even better, but so far I'm down the search and replace route.
tacaswell
approved these changes
Jun 29, 2023
|
Owee, I'm MrMeeseeks, Look at me. There seem to be a conflict, please backport manually. Here are approximate instructions:
And apply the correct labels and milestones. Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon! Remember to remove the If these instructions are inaccurate, feel free to suggest an improvement. |
tacaswell
added a commit
to tacaswell/matplotlib
that referenced
this pull request
Jun 29, 2023
[Doc] Improve documentation types (cherry picked from commit d780621)
|
The conflicts are with #25873 so I'll backport both that PR and this one in one move. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR summary
From https://matplotlib.org/stable/devel/documenting_mpl.html#referencing-types
"Use full references
~matplotlib.colors.Normalizewith an abbreviation tilde in parameter types."This should be all that misses a
~but has a fully qualified name. Then there are quite a lot that doesn't have fully qualified names...PR checklist