Commit2d392cd

authored and

committed

Backport PR#20913: [Doc] colors.to_hex input & output

1 parentf5e2ca5 commit2d392cdCopy full SHA for 2d392cd

File tree

+11

-2

lines changed

+11

-2

lines changed

Lines changed: 11 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -390,8 +390,17 @@ def to_hex(c, keep_alpha=False):`
`390`	`390`	`"""`
`391`	`391`	`Convert c to a hex color.`
`392`	`392`
`393`		- Uses the ``#rrggbb`` format if keep_alpha is False (the default),
`394`		- ``#rrggbbaa`` otherwise.
	`393`	`+ Parameters`
	`394`	`+ ----------`
	`395`	+ c : :doc:`color </tutorials/colors/colors>` or `numpy.ma.masked`
	`396`	`+`
	`397`	`+ keep_alpha: bool, default: False`
	`398`	+ If False, use the ``#rrggbb`` format, otherwise use ``#rrggbbaa``.
	`399`	`+`
	`400`	`+ Returns`
	`401`	`+ -------`
	`402`	`+ str`
	`403`	+ ``#rrggbb`` or ``#rrggbbaa`` hex color string
`395`	`404`	`"""`
`396`	`405`	`c=to_rgba(c)`
`397`	`406`	`ifnotkeep_alpha:`

Comments

(0)