diff options
| author | Maiddog <[email protected]> | 2017-06-03 16:33:46 -0500 |
|---|---|---|
| committer | Zeyla Hellyer <[email protected]> | 2017-06-03 14:33:46 -0700 |
| commit | c00f3490f2fb0c045c2da72d850f70da8e2cdb95 (patch) | |
| tree | dc249377dae54eaac823d82c0764c314ba653cdd /src/builder | |
| parent | Fix compilations across feature combinations (diff) | |
| download | serenity-c00f3490f2fb0c045c2da72d850f70da8e2cdb95.tar.xz serenity-c00f3490f2fb0c045c2da72d850f70da8e2cdb95.zip | |
Add some model docs, deprecate Role::edit_role
Deprecate `Role::edit_role` and rename it to `Role::edit`.
Diffstat (limited to 'src/builder')
| -rw-r--r-- | src/builder/create_embed.rs | 10 | ||||
| -rw-r--r-- | src/builder/create_invite.rs | 4 | ||||
| -rw-r--r-- | src/builder/create_message.rs | 8 | ||||
| -rw-r--r-- | src/builder/edit_channel.rs | 8 | ||||
| -rw-r--r-- | src/builder/edit_guild.rs | 5 | ||||
| -rw-r--r-- | src/builder/edit_member.rs | 3 | ||||
| -rw-r--r-- | src/builder/edit_profile.rs | 4 | ||||
| -rw-r--r-- | src/builder/edit_role.rs | 15 |
8 files changed, 26 insertions, 31 deletions
diff --git a/src/builder/create_embed.rs b/src/builder/create_embed.rs index ff4e2c4..0099936 100644 --- a/src/builder/create_embed.rs +++ b/src/builder/create_embed.rs @@ -2,7 +2,7 @@ //! //! This is a set of embed builders for rich embeds. //! -//! These are used in the [`Context::send_message`] and +//! These are used in the [`ChannelId::send_message`] and //! [`ExecuteWebhook::embeds`] methods, both as part of builders. //! //! The only builder that should be exposed is [`CreateEmbed`]. The rest of @@ -10,7 +10,7 @@ //! //! Documentation for embeds can be found [here]. //! -//! [`Context::send_message`]: ../client/struct.Context.html#method.send_message +//! [`ChannelId::send_message`]: ../model/struct.ChannelId.html#method.send_message //! [`CreateEmbed`]: struct.CreateEmbed.html //! [`ExecuteWebhook::embeds`]: struct.ExecuteWebhook.html#method.embeds //! [here]: https://discordapp.com/developers/docs/resources/channel#embed-object @@ -25,14 +25,14 @@ use ::model::Embed; use ::utils::Colour; /// A builder to create a fake [`Embed`] object, for use with the -/// [`Context::send_message`] and [`ExecuteWebhook::embeds`] methods. +/// [`ChannelId::send_message`] and [`ExecuteWebhook::embeds`] methods. /// /// # Examples /// -/// Refer to the documentation for [`Context::send_message`] for a very in-depth +/// Refer to the documentation for [`ChannelId::send_message`] for a very in-depth /// example on how to use this. /// -/// [`Context::send_message`]: ../client/struct.Context.html#method.send_message +/// [`ChannelId::send_message`]: ../model/struct.ChannelId.html#method.send_message /// [`Embed`]: ../model/struct.Embed.html /// [`ExecuteWebhook::embeds`]: struct.ExecuteWebhook.html#method.embeds #[derive(Clone, Debug)] diff --git a/src/builder/create_invite.rs b/src/builder/create_invite.rs index 98fc2b9..bd76ed8 100644 --- a/src/builder/create_invite.rs +++ b/src/builder/create_invite.rs @@ -2,7 +2,7 @@ use serde_json::Value; use std::default::Default; use ::internal::prelude::*; -/// A builder to create a [`RichInvite`] for use via [`Context::create_invite`]. +/// A builder to create a [`RichInvite`] for use via [`GuildChannel::create_invite`]. /// /// This is a structured and cleaner way of creating an invite, as all /// parameters are optional. @@ -52,7 +52,7 @@ use ::internal::prelude::*; /// }); /// ``` /// -/// [`Context::create_invite`]: ../client/struct.Context.html#method.create_invite +/// [`GuildChannel::create_invite`]: ../model/struct.GuildChannel.html#method.create_invite /// [`RichInvite`]: ../model/struct.Invite.html #[derive(Clone, Debug)] pub struct CreateInvite(pub JsonMap); diff --git a/src/builder/create_message.rs b/src/builder/create_message.rs index 14be4ca..e9e8bf5 100644 --- a/src/builder/create_message.rs +++ b/src/builder/create_message.rs @@ -3,7 +3,7 @@ use ::model::ReactionType; use ::internal::prelude::*; /// A builder to specify the contents of an [`http::send_message`] request, -/// primarily meant for use through [`Context::send_message`]. +/// primarily meant for use through [`ChannelId::send_message`]. /// /// There are two situations where different field requirements are present: /// @@ -12,7 +12,7 @@ use ::internal::prelude::*; /// set. /// /// Note that if you only need to send the content of a message, without -/// specifying other fields, then [`Context::say`] may be a more preferable +/// specifying other fields, then [`ChannelId::say`] may be a more preferable /// option. /// /// # Examples @@ -32,8 +32,8 @@ use ::internal::prelude::*; /// .description("With a description"))); /// ``` /// -/// [`Context::say`]: ../client/struct.Context.html#method.say -/// [`Context::send_message`]: ../client/struct.Context.html#method.send_message +/// [`ChannelId::say`]: ../model/struct.ChannelId.html#method.say +/// [`ChannelId::send_message`]: ../model/struct.ChannelId.html#method.send_message /// [`content`]: #method.content /// [`embed`]: #method.embed /// [`http::send_message`]: ../http/fn.send_message.html diff --git a/src/builder/edit_channel.rs b/src/builder/edit_channel.rs index 2bf8979..9d859c7 100644 --- a/src/builder/edit_channel.rs +++ b/src/builder/edit_channel.rs @@ -1,11 +1,6 @@ use ::internal::prelude::*; -/// A builder to edit a [`GuildChannel`] for use via one of a couple methods. -/// -/// These methods are: -/// -/// - [`Context::edit_channel`] -/// - [`GuildChannel::edit`] +/// A builder to edit a [`GuildChannel`] for use via [`GuildChannel::edit`] /// /// Defaults are not directly provided by the builder itself. /// @@ -20,7 +15,6 @@ use ::internal::prelude::*; /// } /// ``` /// -/// [`Context::edit_channel`]: ../client/struct.Context.html#method.edit_channel /// [`GuildChannel`]: ../model/struct.GuildChannel.html /// [`GuildChannel::edit`]: ../model/struct.GuildChannel.html#method.edit #[derive(Clone, Debug, Default)] diff --git a/src/builder/edit_guild.rs b/src/builder/edit_guild.rs index c01b8ea..e74e54e 100644 --- a/src/builder/edit_guild.rs +++ b/src/builder/edit_guild.rs @@ -2,14 +2,13 @@ use ::internal::prelude::*; use ::model::{ChannelId, Region, UserId, VerificationLevel}; /// A builder to optionally edit certain fields of a [`Guild`]. This is meant -/// for usage with [`Context::edit_guild`] and [`LiveGuild::edit`]. +/// for usage with [`Guild::edit`]. /// /// **Note**: Editing a guild requires that the current user have the /// [Manage Guild] permission. /// -/// [`Context::edit_guild`]: ../client/struct.Context.html +/// [`Guild::edit`]: ../model/struct.Guild.html#method.edit /// [`Guild`]: ../model/struct.Guild.html -/// [`LiveGuild::edit`]: ../model/struct.LiveGuild.html#method.edit /// [Manage Guild]: ../model/permissions/constant.MANAGE_GUILD.html #[derive(Clone, Debug, Default)] pub struct EditGuild(pub Map<String, Value>); diff --git a/src/builder/edit_member.rs b/src/builder/edit_member.rs index 044d8f2..3fce146 100644 --- a/src/builder/edit_member.rs +++ b/src/builder/edit_member.rs @@ -2,9 +2,8 @@ use ::model::{ChannelId, RoleId}; use ::internal::prelude::*; /// A builder which edits the properties of a [`Member`], to be used in -/// conjunction with [`Context::edit_member`] and [`Member::edit`]. +/// conjunction with [`Member::edit`]. /// -/// [`Context::edit_member`]: ../client/struct.Context.html#method.edit_member /// [`Member`]: ../model/struct.Member.html /// [`Member::edit`]: ../model/struct.Member.html#method.edit #[derive(Clone, Debug, Default)] diff --git a/src/builder/edit_profile.rs b/src/builder/edit_profile.rs index a4b5c99..2d4df85 100644 --- a/src/builder/edit_profile.rs +++ b/src/builder/edit_profile.rs @@ -1,9 +1,9 @@ use ::internal::prelude::*; /// A builder to edit the current user's settings, to be used in conjunction -/// with [`Context::edit_profile`]. +/// with [`CurrentUser::edit`]. /// -/// [`Context::edit_profile`]: ../client/struct.Context.html#method.edit_profile +/// [`CurrentUser::edit`]: ../model/struct.CurrentUser.html#method.edit #[derive(Clone, Debug, Default)] pub struct EditProfile(pub JsonMap); diff --git a/src/builder/edit_role.rs b/src/builder/edit_role.rs index f17947a..6be09fe 100644 --- a/src/builder/edit_role.rs +++ b/src/builder/edit_role.rs @@ -2,14 +2,15 @@ use std::default::Default; use ::internal::prelude::*; use ::model::{Permissions, Role, permissions}; -/// A builer to create or edit a [`Role`] for use via a number of model and -/// context methods. +/// A builer to create or edit a [`Role`] for use via a number of model methods. /// /// These are: /// -/// - [`Context::create_role`] -/// - [`Context::edit_role`] +/// - [`PartialGuild::create_role`] /// - [`Guild::create_role`] +/// - [`Guild::edit_role`] +/// - [`GuildId::create_role`] +/// - [`GuildId::edit_role`] /// - [`Role::edit`] /// /// Defaults are provided for each parameter on role creation. @@ -30,9 +31,11 @@ use ::model::{Permissions, Role, permissions}; /// .name("a test role")); /// ``` /// -/// [`Context::create_role`]: ../client/struct.Context.html#method.create_role -/// [`Context::edit_role`]: ../client/struct.Context.html#method.edit_role +/// [`PartialGuild::create_role`]: ../model/struct.PartialGuild.html#method.create_role /// [`Guild::create_role`]: ../model/struct.Guild.html#method.create_role +/// [`Guild::edit_role`]: ../model/struct.Guild.html#method.edit_role +/// [`GuildId::create_role`]: ../model/struct.GuildId.html#method.create_role +/// [`GuildId::edit_role`]: ../model/struct.GuildId.html#method.edit_role /// [`Role`]: ../model/struct.Role.html /// [`Role::edit`]: ../model/struct.Role.html#method.edit #[derive(Clone, Debug)] |