mirrors/discord.py
1
0
Fork 0
mirror of https://github.com/Rapptz/discord.py.git synced 2025-04-22 16:51:59 +00:00
Code Issues Projects Releases Wiki Activity

Clarify Colour.random RNG

Browse Source
This commit is contained in:
Rapptz 2020-11-21 22:18:39 -05:00
parent 896a5bef1d
commit 6caa983b5e
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
discord/colour.py
View File

@ -120,7 +120,15 @@ class Colour:
@classmethod
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)
@classmethod
@ -245,7 +253,7 @@ class Colour:
def dark_theme(cls):
"""A factory method that returns a :class:`Colour` with a value of ``0x36393F``.
This will appear transparent on Discord's dark theme.
.. versionadded:: 1.5
"""
return cls(0x36393F)