-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
[Doc] colors.to_hex input & output #20913
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
lib/matplotlib/colors.py
Outdated
|
||
Parameters | ||
---------- | ||
c : Matplotlib color or ``np.ma.masked`` |
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.
just "color" (we say "color" in a bunch of doc descriptions to mean "matplotlib color"; this is not different).
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 was super confused by what is color - RGBA, named, all of the above? (should color maybe cross link to https://matplotlib.org/devdocs/tutorials/colors/colors.html?)
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.
Perhaps, but that should probably be another discussion, similar to the joinstyle/capstyle one.
821f268
to
73db5b5
Compare
73db5b5
to
58e8b94
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.
Like :rc:`some.param`
, we should have a :concept:`color`
directive (or similar) to make such links easier. But until then an explicit link is ok as well.
Co-authored-by: Tim Hoffmann <[email protected]>
Co-authored-by: Tim Hoffmann <[email protected]>
Co-authored-by: David Stansby <[email protected]>
lib/matplotlib/colors.py
Outdated
``#rrggbbaa`` otherwise. | ||
Parameters | ||
---------- | ||
c : :doc:`color </tutorials/colors/colors>` or `np.ma.masked` |
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.
c : :doc:`color </tutorials/colors/colors>` or `np.ma.masked` | |
c : :doc:`color </tutorials/colors/colors>` or `numpy.ma.masked` |
Sorry, need the original name to make the link working.
…913-on-v3.5.x Backport PR #20913 on branch v3.5.x ([Doc] colors.to_hex input & output)
[Doc] colors.to_hex input & output
[Doc] colors.to_hex input & output
added numpydoc style documentation of parameters to the colors.to_hex function