aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorNikita Pekin <[email protected]>2018-01-05 19:43:34 -0500
committerZeyla Hellyer <[email protected]>2018-01-10 11:32:25 -0800
commitb52eb9f108fb7af182e0cf29259cd4d522ed7f89 (patch)
treea7ecc1d4f5524397e5da1ae22f5b53578868bd8b /src
parentRemove `is_bot` boolean from framework (diff)
downloadserenity-b52eb9f108fb7af182e0cf29259cd4d522ed7f89.tar.xz
serenity-b52eb9f108fb7af182e0cf29259cd4d522ed7f89.zip
Fix docs for User::has_role
Update the docs for `User::has_role` to reflect that `Into<GuildContainer>` is only implemented for `PartialGuild`, `GuildId`, and `u64`, not `Guild`. (cherry picked from commit 00deef894ec458ac8abff914ed864ea63c47eda6)
Diffstat (limited to 'src')
-rw-r--r--src/model/user.rs7
1 files changed, 4 insertions, 3 deletions
diff --git a/src/model/user.rs b/src/model/user.rs
index 4a10566..227fadf 100644
--- a/src/model/user.rs
+++ b/src/model/user.rs
@@ -561,19 +561,20 @@ impl User {
/// given [`Role`].
///
/// Three forms of data may be passed in to the guild parameter: either a
- /// [`Guild`] itself, a [`GuildId`], or a `u64`.
+ /// [`PartialGuild`], a [`GuildId`], or a `u64`.
///
/// # Examples
///
/// Check if a guild has a [`Role`] by Id:
///
/// ```rust,ignore
- /// // Assumes a 'guild' and `role_id` have already been bound
- /// let _ = message.author.has_role(guild, role_id);
+ /// // Assumes a 'guild_id' and `role_id` have already been bound
+ /// let _ = message.author.has_role(guild_id, role_id);
/// ```
///
/// [`Guild`]: struct.Guild.html
/// [`GuildId`]: struct.GuildId.html
+ /// [`PartialGuild`]: struct.PartialGuild.html
/// [`Role`]: struct.Role.html
/// [`Cache`]: ../cache/struct.Cache.html
// no-cache would warn on guild_id.