Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
DOC: Add descriptions to matplotlib.typing#29918
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
.. autodata:: matplotlib.typing.ColourType | ||
.. autodata:: matplotlib.typing.RGBColourType | ||
.. autodata:: matplotlib.typing.RGBAColourType |
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.
These seem to need docstrings, even if they are just "Alias of ...", because right now they are the rather unclear "Represent a PEP 604 union type".
Also, any idea why these colour types seem to get the type alias in bold next to the name, whereas the style ones seem to get "alias of ..." in the description instead?
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've noted this as well, but decided to not bother right now. I don't want to spend time on it, and it's not getting worse through the PR.
There must be some issue in autodoc. If that gets fixed, we should get the right description automatically.
More fundamentally, why do we need these aliases? All our function/parameter names use "color" and we don't alias them. I'm tempted to remove the aliases here (only leaving them for now because as said, I don't want to spend much time on this)
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.
If I had my way, I'd have the colour spelling available everywhere, but I don't remember why these specifically are here.
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've add docstrings to the aliases for now. Though, I'd propose to remove the aliases because AFAIK we don't have aliases anywhere else in the API. But that's a separeate discussion.
6378dd0
intomatplotlib:mainUh oh!
There was an error while loading.Please reload this page.
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 tosuggest an improvement. |
Not worth a manual backport. |
PR summary
PR checklist