aboutsummaryrefslogtreecommitdiff
path: root/src/model/misc.rs
diff options
context:
space:
mode:
authorZeyla Hellyer <[email protected]>2017-03-25 15:35:50 -0700
committerZeyla Hellyer <[email protected]>2017-03-25 15:35:50 -0700
commit356c9c0d42f4b0583a2c7b5333196c4f4e6a73cc (patch)
treefe4296b5c07b32be2c3a7d1f2169fe3f00c1a415 /src/model/misc.rs
parentFix Member methods due to variant joined_at values (diff)
downloadserenity-356c9c0d42f4b0583a2c7b5333196c4f4e6a73cc.tar.xz
serenity-356c9c0d42f4b0583a2c7b5333196c4f4e6a73cc.zip
Add slightly more documentation
Diffstat (limited to 'src/model/misc.rs')
-rw-r--r--src/model/misc.rs2
1 files changed, 2 insertions, 0 deletions
diff --git a/src/model/misc.rs b/src/model/misc.rs
index 3784a59..118492c 100644
--- a/src/model/misc.rs
+++ b/src/model/misc.rs
@@ -17,6 +17,8 @@ use ::utils;
/// Allows something - such as a channel or role - to be mentioned in a message.
pub trait Mentionable {
+ /// Creates a mentionable string, that will be able to notify and/or create
+ /// a link to the item.
fn mention(&self) -> String;
}