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-05 16:43:34 -0800
commit00deef894ec458ac8abff914ed864ea63c47eda6 (patch)
tree3d884454f33585863c18272bdfc0157ef7342946 /src
parentFix syntax highlighting in README (diff)
downloadserenity-00deef894ec458ac8abff914ed864ea63c47eda6.tar.xz
serenity-00deef894ec458ac8abff914ed864ea63c47eda6.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`.
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 bf725cc..cb9d16f 100644
--- a/src/model/user.rs
+++ b/src/model/user.rs
@@ -571,19 +571,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.