Clarify Colour.random RNG
This commit is contained in:
parent
896a5bef1d
commit
6caa983b5e
@ -120,7 +120,15 @@ class Colour:
|
|||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def random(cls):
|
def random(cls):
|
||||||
"""A factory method that returns a :class:`Colour` with a random value."""
|
"""A factory method that returns a :class:`Colour` with a random hue.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
The random algorithm works by choosing a colour with a random hue but
|
||||||
|
with maxed out saturation and value.
|
||||||
|
|
||||||
|
.. versionadded:: 1.6
|
||||||
|
"""
|
||||||
return cls.from_hsv(random.random(), 1, 1)
|
return cls.from_hsv(random.random(), 1, 1)
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
|
Loading…
x
Reference in New Issue
Block a user