aboutsummaryrefslogtreecommitdiff
path: root/src/model
diff options
context:
space:
mode:
authorZeyla Hellyer <[email protected]>2017-11-18 20:10:26 -0800
committerZeyla Hellyer <[email protected]>2017-11-18 20:10:26 -0800
commit141bbfcb1e4843eaeb55bf07e10e2c0aa4bbe1e4 (patch)
tree68a4785000c951672b5dd7e5acce792a14692d9a /src/model
parentAdd a method to get a message from a reaction (#220) (diff)
downloadserenity-141bbfcb1e4843eaeb55bf07e10e2c0aa4bbe1e4.tar.xz
serenity-141bbfcb1e4843eaeb55bf07e10e2c0aa4bbe1e4.zip
Document that Reaction methods that hit the API
Documents that the following `model::Reaction` methods hit the REST API: - `message` - `users`
Diffstat (limited to 'src/model')
-rw-r--r--src/model/channel/reaction.rs10
1 files changed, 8 insertions, 2 deletions
diff --git a/src/model/channel/reaction.rs b/src/model/channel/reaction.rs
index 1e6c454..caee8e2 100644
--- a/src/model/channel/reaction.rs
+++ b/src/model/channel/reaction.rs
@@ -35,7 +35,7 @@ impl Reaction {
/// Deletes the reaction, but only if the current user is the user who made
/// the reaction or has permission to.
///
- /// **Note**: Requires the [Manage Messages] permission, _if_ the current
+ /// Requires the [Manage Messages] permission, _if_ the current
/// user did not perform the reaction.
///
/// # Errors
@@ -89,7 +89,9 @@ impl Reaction {
/// The optional `after` attribute is to retrieve the users after a certain
/// user. This is useful for pagination.
///
- /// **Note**: Requires the [Read Message History] permission.
+ /// Requires the [Read Message History] permission.
+ ///
+ /// **Note**: This will send a request to the REST API.
///
/// # Errors
///
@@ -121,6 +123,10 @@ impl Reaction {
///
/// Requires the [Read Message History] permission.
///
+ /// **Note**: This will send a request to the REST API. Prefer maintaining
+ /// your own message cache or otherwise having the message available if
+ /// possible.
+ ///
/// [Read Message History]: permissions/constant.READ_MESSAGE_HISTORY.html
/// [`Message`]: struct.Message.html
pub fn message(&self) -> Result<Message> {