aboutsummaryrefslogtreecommitdiff
path: root/src/model
diff options
context:
space:
mode:
authorAustin Hellyer <[email protected]>2016-11-05 16:32:42 -0700
committerAustin Hellyer <[email protected]>2016-11-05 16:32:42 -0700
commitaab12ec36bda78121e1c4de4bc48822bd2b5d8a5 (patch)
tree5d58844781983b6c43003838ad7a0fac0f03bdbe /src/model
parentSupport major parameters in ratelimits (diff)
downloadserenity-aab12ec36bda78121e1c4de4bc48822bd2b5d8a5.tar.xz
serenity-aab12ec36bda78121e1c4de4bc48822bd2b5d8a5.zip
Fix doc links to enum variants
Most of the docs were linking to `enum.EnumName.html#VariantName.v`, which should have been linking to `enum.EnumName.html#variant.VariantName`.
Diffstat (limited to 'src/model')
-rw-r--r--src/model/channel.rs18
-rw-r--r--src/model/guild.rs24
-rw-r--r--src/model/mod.rs4
-rw-r--r--src/model/permissions.rs2
4 files changed, 24 insertions, 24 deletions
diff --git a/src/model/channel.rs b/src/model/channel.rs
index fa26bc5..4fa08b9 100644
--- a/src/model/channel.rs
+++ b/src/model/channel.rs
@@ -142,7 +142,7 @@ impl Group {
/// [`ClientError::DeleteMessageDaysAmount`] if the number of messages to
/// delete is not within the valid range.
///
- /// [`ClientError::DeleteMessageDaysAmount`]: ../client/enum.ClientError.html#DeleteMessageDaysAmount.v
+ /// [`ClientError::DeleteMessageDaysAmount`]: ../client/enum.ClientError.html#variant.DeleteMessageDaysAmount
/// [`Context::delete_messages`]: ../client/struct.Context.html#delete_messages
pub fn delete_messages(&self, message_ids: &[MessageId]) -> Result<()> {
if message_ids.len() < 2 || message_ids.len() > 100 {
@@ -248,8 +248,8 @@ impl Message {
/// Returns a [`ClientError::InvalidPermissions`] if the current user does
/// not have the required permissions.
///
- /// [`ClientError::InvalidPermissions]: ../client/enum.ClientError.html#InvalidPermissions.v
- /// [`ClientError::InvalidUser]: ../client/enum.ClientError.html#InvalidUser.v
+ /// [`ClientError::InvalidPermissions]: ../client/enum.ClientError.html#variant.InvalidPermissions
+ /// [`ClientError::InvalidUser]: ../client/enum.ClientError.html#variant.InvalidUser
/// [Manage Messages]: permissions/constant.MANAGE_MESSAGES.html
pub fn delete(&self) -> Result<()> {
let req = permissions::MANAGE_MESSAGES;
@@ -275,7 +275,7 @@ impl Message {
/// Returns a
/// [`ClientError::InvalidUser`] if the current user is not the author.
///
- /// [`ClientError::InvalidUser`]: ../client/enum.ClientError.html#InvalidUser.v
+ /// [`ClientError::InvalidUser`]: ../client/enum.ClientError.html#variant.InvalidUser
pub fn edit(&mut self, new_content: &str) -> Result<()> {
if self.author.id != STATE.lock().unwrap().user.id {
return Err(Error::Client(ClientError::InvalidUser));
@@ -305,7 +305,7 @@ impl Message {
/// [`ClientError::InvalidPermissions`] if the current user does not have
/// the required permissions.
///
- /// [`ClientError::InvalidPermissions`]: ../client/enum.ClientError.html#InvalidPermissions.v
+ /// [`ClientError::InvalidPermissions`]: ../client/enum.ClientError.html#variant.InvalidPermissions
/// [Manage Messages]: permissions/constant.MANAGE_MESSAGES.html
pub fn pin(&self) -> Result<()> {
let req = permissions::MANAGE_MESSAGES;
@@ -355,7 +355,7 @@ impl Message {
/// [`ClientError::InvalidPermissions`] if the current user does not have
/// the required permissions.
///
- /// [`ClientError::InvalidPermissions`]: ../client/enum.ClientError.html#InvalidPermissions.v
+ /// [`ClientError::InvalidPermissions`]: ../client/enum.ClientError.html#variant.InvalidPermissions
/// [Send Messages]: permissions/constant.SEND_MESSAGES.html
pub fn reply(&self, content: &str) -> Result<Message> {
let req = permissions::SEND_MESSAGES;
@@ -388,7 +388,7 @@ impl Message {
/// [`ClientError::InvalidPermissions`] if the current user does not have
/// the required permissions.
///
- /// [`ClientError::InvalidPermissions`]: ../client/enum.ClientError.html#InvalidPermissions.v
+ /// [`ClientError::InvalidPermissions`]: ../client/enum.ClientError.html#variant.InvalidPermissions
/// [Manage Messages]: permissions/constant.MANAGE_MESSAGES.html
pub fn unpin(&self) -> Result<()> {
let req = permissions::MANAGE_MESSAGES;
@@ -452,7 +452,7 @@ impl PrivateChannel {
/// Returns a
/// [`ClientError::InvalidUser`] if the current user is not a bot user.
///
- /// [`ClientError::InvalidUser`]: ../client/enum.ClientError.html#InvalidOperationAsUser.v
+ /// [`ClientError::InvalidUser`]: ../client/enum.ClientError.html#variant.InvalidOperationAsUser
pub fn delete_messages(&self, message_ids: &[MessageId]) -> Result<()> {
if !STATE.lock().unwrap().user.bot {
return Err(Error::Client(ClientError::InvalidOperationAsUser));
@@ -514,7 +514,7 @@ impl PublicChannel {
/// [ClientError::InvalidPermissions] if the current user does not have the
/// required permissions.
///
- /// [`ClientError::InvalidPermissions`]: ../client/enum.ClientError.html#InvalidPermissions.v
+ /// [`ClientError::InvalidPermissions`]: ../client/enum.ClientError.html#variant.InvalidPermissions
/// [Send Messages]: permissions/constants.SEND_MESSAGES.html
pub fn broadcast_typing(&self) -> Result<()> {
http::broadcast_typing(self.id.0)
diff --git a/src/model/guild.rs b/src/model/guild.rs
index 1e4fea8..322233f 100644
--- a/src/model/guild.rs
+++ b/src/model/guild.rs
@@ -164,8 +164,8 @@ impl LiveGuild {
/// Returns a [`ClientError::DeleteMessageDaysAmount`] if the number of
/// days' worth of messages to delete is over the maximum.
///
- /// [`ClientError::DeleteMessageDaysAmount`]: ../client/enum.ClientError.html#DeleteMessageDaysAmount.v
- /// [`ClientError::InvalidPermissions`]: ../client/enum.ClientError.html#InvalidPermissions.v
+ /// [`ClientError::DeleteMessageDaysAmount`]: ../client/enum.ClientError.html#variant.DeleteMessageDaysAmount
+ /// [`ClientError::InvalidPermissions`]: ../client/enum.ClientError.html#variant.InvalidPermissions
/// [`User`]: struct.User.html
/// [Ban Members]: permissions/constant.BAN_MEMBERS.html
pub fn ban<U: Into<UserId>>(&self, user: U, delete_message_days: u8)
@@ -193,7 +193,7 @@ impl LiveGuild {
/// not have permission to perform bans.
///
/// [`Ban`]: struct.Ban.html
- /// [`ClientError::InvalidPermissions`]: ../client/enum.ClientError.html#InvalidPermissions.v
+ /// [`ClientError::InvalidPermissions`]: ../client/enum.ClientError.html#variant.InvalidPermissions
/// [Ban Members]: permissions/constant.BAN_MEMBERS.html
pub fn bans(&self) -> Result<Vec<Ban>> {
let req = permissions::BAN_MEMBERS;
@@ -223,7 +223,7 @@ impl LiveGuild {
/// not have permission to perform bans.
///
/// [`Channel`]: struct.Channel.html
- /// [`ClientError::InvalidPermissions`]: ../client/enum.ClientError.html#InvalidPermissions.v
+ /// [`ClientError::InvalidPermissions`]: ../client/enum.ClientError.html#variant.InvalidPermissions
/// [Manage Channels]: permissions/constants.MANAGE_CHANNELS.html
pub fn create_channel(&mut self, name: &str, kind: ChannelType)
-> Result<Channel> {
@@ -254,7 +254,7 @@ impl LiveGuild {
/// Returns a [`ClientError::InvalidPermissions`] if the current user does
/// not have permission to perform bans.
///
- /// [`ClientError::InvalidPermissions`]: ../client/enum.ClientError.html#InvalidPermissions.v
+ /// [`ClientError::InvalidPermissions`]: ../client/enum.ClientError.html#variant.InvalidPermissions
/// [`Context::create_role`]: ../client/struct.Context.html#method.create_role
/// [`Role`]: struct.Role.html
/// [Manage Roles]: permissions/constants.MANAGE_ROLES.html
@@ -329,7 +329,7 @@ impl LiveGuild {
/// Returns a [`ClientError::InvalidUser`] if the current user is not the
/// guild owner.
///
- /// [`ClientError::InvalidUser`]: ../client/enum.ClientError.html#InvalidUser.v
+ /// [`ClientError::InvalidUser`]: ../client/enum.ClientError.html#variant.InvalidUser
pub fn delete(&self) -> Result<Guild> {
if self.owner_id != STATE.lock().unwrap().user.id {
let req = permissions::MANAGE_GUILD;
@@ -351,7 +351,7 @@ impl LiveGuild {
/// Returns a [`ClientError::InvalidPermissions`] if the current user does
/// not have permission to perform bans.
///
- /// [`ClientError::InvalidPermissions`]: ../client/enum.ClientError.html#InvalidPermissions.v
+ /// [`ClientError::InvalidPermissions`]: ../client/enum.ClientError.html#variant.InvalidPermissions
/// [`Context::edit_guild`]: ../client/struct.Context.html#method.edit_guild
/// [Manage Guild]: permissions/constants.MANAGE_GUILD.html
pub fn edit<F>(&mut self, f: F) -> Result<()>
@@ -403,7 +403,7 @@ impl LiveGuild {
/// Returns a [`ClientError::InvalidPermissions`] if the current user does
/// not have permission to perform bans.
///
- /// [`ClientError::InvalidPermissions`]: ../client/enum.ClientError.html#InvalidPermissions.v
+ /// [`ClientError::InvalidPermissions`]: ../client/enum.ClientError.html#variant.InvalidPermissions
/// [Manage Guild]: permissions/constant.MANAGE_GUILD.html
pub fn get_invites(&self) -> Result<Vec<RichInvite>> {
let req = permissions::MANAGE_GUILD;
@@ -606,7 +606,7 @@ impl LiveGuild {
/// Returns a [`ClientError::InvalidPermissions`] if the current user does
/// not have permission to perform bans.
///
- /// [`ClientError::InvalidPermissions`]: ../client/enum.ClientError.html#InvalidPermissions.v
+ /// [`ClientError::InvalidPermissions`]: ../client/enum.ClientError.html#variant.InvalidPermissions
/// [`GuildPrune`]: struct.GuildPrune.html
/// [`Member`]: struct.Member.html
/// [Kick Members]: permissions/constant.KICK_MEMBERS.html
@@ -635,7 +635,7 @@ impl LiveGuild {
/// Returns a [`ClientError::InvalidPermissions`] if the current user does
/// not have permission to perform bans.
///
- /// [`ClientError::InvalidPermissions`]: ../client/enum.ClientError.html#InvalidPermissions.v
+ /// [`ClientError::InvalidPermissions`]: ../client/enum.ClientError.html#variant.InvalidPermissions
/// [`GuildPrune`]: struct.GuildPrune.html
/// [`Member`]: struct.Member.html
/// [Kick Members]: permissions/constant.KICK_MEMBERS.html
@@ -662,7 +662,7 @@ impl LiveGuild {
/// Returns a [`ClientError::InvalidPermissions`] if the current user does
/// not have permission to perform bans.
///
- /// [`ClientError::InvalidPermissions`]: ../client/enum.ClientError.html#InvalidPermissions.v
+ /// [`ClientError::InvalidPermissions`]: ../client/enum.ClientError.html#variant.InvalidPermissions
/// [`User`]: struct.User.html
/// [Ban Members]: permissions/constant.BAN_MEMBERS.html
pub fn unban<U: Into<UserId>>(&self, user: U) -> Result<()> {
@@ -889,7 +889,7 @@ impl Role {
/// Returns a [`ClientError::GuildNotFound`] if a guild is not in the state
/// that contains the role.
///
- /// [`ClientError::GuildNotFound`]: ../client/enum.ClientError.html#GuildNotFound.v
+ /// [`ClientError::GuildNotFound`]: ../client/enum.ClientError.html#variant.GuildNotFound
pub fn find_guild(&self) -> Result<GuildId> {
STATE.lock()
.unwrap()
diff --git a/src/model/mod.rs b/src/model/mod.rs
index 8478cc2..2212747 100644
--- a/src/model/mod.rs
+++ b/src/model/mod.rs
@@ -100,8 +100,8 @@ pub enum Channel {
/// A [text] or [voice] channel within a [`Guild`].
///
/// [`Guild`]: struct.Guild.html
- /// [text]: enum.ChannelType.html#Text.v
- /// [voice]: enum.ChannelType.html#Voice.v
+ /// [text]: enum.ChannelType.html#variant.Text
+ /// [voice]: enum.ChannelType.html#variant.Voice
Public(PublicChannel),
}
diff --git a/src/model/permissions.rs b/src/model/permissions.rs
index 3bcf219..b14ab82 100644
--- a/src/model/permissions.rs
+++ b/src/model/permissions.rs
@@ -224,7 +224,7 @@ bitflags! {
/// If this is disabled, then [`Member`]s must use push-to-talk.
///
/// [`Member`]: ../struct.Member.html
- /// [voice]: ../enum.ChannelType.html#Voice.v
+ /// [voice]: ../enum.ChannelType.html#variant.Voice
const USE_VAD = 1 << 25,
/// Allows members to change their own nickname in the guild.
const CHANGE_NICKNAME = 1 << 26,