-
-
Notifications
You must be signed in to change notification settings - Fork 8k
[Doc] Improve documentation types #26186
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
Conversation
db98e70 to
c33bccf
Compare
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.
Yes, this one can be even better, but so far I'm down the search and replace route.
c33bccf to
8206238
Compare
8206238 to
c85551c
Compare
Owee, I'm MrMeeseeks, Look at me.
There seem to be a conflict, please backport manually. Here are approximate instructions:
- Checkout backport branch and update it.
git checkout v3.7.x
git pull
- Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -x -m1 d78062174b78d240f913a429672b9656b9f16485
- You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #26186: [Doc] Improve documentation types'
- Push to a named branch:
git push YOURFORK v3.7.x:auto-backport-of-pr-26186-on-v3.7.x
- Create a PR against branch v3.7.x, I would have named this PR:
"Backport PR #26186 on branch v3.7.x ([Doc] Improve documentation types)"
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 Still Needs Manual Backport label once the PR gets merged.
If these instructions are inaccurate, feel free to suggest an improvement.
[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.
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