aboutsummaryrefslogtreecommitdiff
path: root/src/model/guild.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/model/guild.rs
parentMove HTTP/ratelimiting into a separate module (diff)
downloadserenity-8f145f223804b869df2304a64ce5d3d42c772226.tar.xz
serenity-8f145f223804b869df2304a64ce5d3d42c772226.zip
Add some more documentation
Diffstat (limited to 'src/model/guild.rs')
-rw-r--r--src/model/guild.rs11
1 files changed, 6 insertions, 5 deletions
diff --git a/src/model/guild.rs b/src/model/guild.rs
index 9b4bee1..a72a187 100644
--- a/src/model/guild.rs
+++ b/src/model/guild.rs
@@ -212,7 +212,9 @@ impl LiveGuild {
/// # Examples
///
/// ```rust,ignore
- /// use serenity::models::ChannelType;
+ /// use serenity::model::ChannelType;
+ ///
+ /// // assuming a `guild` has already been bound
///
/// let _ = guild.create_channel("my-test-channel", ChannelType::Text);
/// ```
@@ -241,13 +243,11 @@ impl LiveGuild {
http::create_channel(self.id.0, map)
}
- /// Creates a new [`Role`] in the guild with the data set,
- /// if any.
+ /// Creates a new [`Role`] in the guild with the data set, if any.
///
/// See the documentation for [`Context::create_role`] on how to use this.
///
- /// **Note**: Requires the
- /// [Manage Roles] permission.
+ /// **Note**: Requires the [Manage Roles] permission.
///
/// # Errors
///
@@ -812,6 +812,7 @@ impl fmt::Display for Member {
/// // assumes a `member` has already been bound
/// println!("{} is a member!", member);
/// ```
+ ///
// This is in the format of `<@USER_ID>`.
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
fmt::Display::fmt(&self.user.mention(), f)