Skip to content

[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.

Sign up for GitHub

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

Merged
timhoffm merged 4 commits into from
Sep 13, 2021
Merged

[Doc] colors.to_hex input & output #20913

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
58e8b94
numpydoc style parameters and link to colors tutorial for colors.to_hex
story645 Aug 26, 2021
a248e60
Update lib/matplotlib/colors.py
story645 Aug 27, 2021
6529020
Update lib/matplotlib/colors.py
story645 Aug 27, 2021
143c30e
Update lib/matplotlib/colors.py
story645 Sep 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
numpydoc style parameters and link to colors tutorial for colors.to_hex
  • Loading branch information
@story645
story645 committed Aug 26, 2021
commit 58e8b948198206d30c139ce7aef306844e13d897
14 changes: 12 additions & 2 deletions lib/matplotlib/colors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -390,8 +390,18 @@ def to_hex(c, keep_alpha=False):
"""
Convert *c* to a hex color.

Uses the ``#rrggbb`` format if *keep_alpha* is False (the default),
``#rrggbbaa`` otherwise.
Parameters
----------
c : :doc:`color </tutorials/colors/colors>` or ``np.ma.masked``
Comment thread
story645 marked this conversation as resolved.
Outdated

keep_alpha: bool, optional
Uses the ``#rrggbb`` format if *keep_alpha* is False (the default),
otherwise uses ``#rrggbbaa``.
Comment thread
story645 marked this conversation as resolved.
Outdated

Returns
-------
str
``#rrggbb`` or ``#rrggbbaa`` hex color string
"""
c = to_rgba(c)
if not keep_alpha:
Expand Down