aboutsummaryrefslogtreecommitdiff
path: root/src/utils/colour.rs
diff options
context:
space:
mode:
authorAustin Hellyer <[email protected]>2016-11-06 10:17:08 -0800
committerAustin Hellyer <[email protected]>2016-11-06 10:17:08 -0800
commit8f145f223804b869df2304a64ce5d3d42c772226 (patch)
tree285a7c187c876f9acd1eaf5c7031704209bcf01e /src/utils/colour.rs
parentMove HTTP/ratelimiting into a separate module (diff)
downloadserenity-8f145f223804b869df2304a64ce5d3d42c772226.tar.xz
serenity-8f145f223804b869df2304a64ce5d3d42c772226.zip
Add some more documentation
Diffstat (limited to 'src/utils/colour.rs')
-rw-r--r--src/utils/colour.rs6
1 files changed, 4 insertions, 2 deletions
diff --git a/src/utils/colour.rs b/src/utils/colour.rs
index 7bb7bfd..b9a3bf5 100644
--- a/src/utils/colour.rs
+++ b/src/utils/colour.rs
@@ -17,7 +17,7 @@ macro_rules! colour {
/// as the API works with an integer value instead of an RGB value.
///
/// Instances can be created by using the struct's associated functions. These
-/// produce values equivilant to those found in the official client's colour
+/// produce presets equivilant to those found in the official client's colour
/// picker.
///
/// # Examples
@@ -36,12 +36,14 @@ macro_rules! colour {
/// println!("The green component is: {}", green);
/// ```
///
-/// Creating an instance with the [`dark_teal`] value:
+/// Creating an instance with the [`dark_teal`] presets:
///
/// ```rust,ignore
/// use serenity::utils::Colour;
///
/// let colour = Colour::dark_teal();
+///
+/// assert_eq!(colour.get_tuple(), (17, 128, 106));
/// ```
///
/// [`Role`]: ../model/struct.Role.html