aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorLakelezz <[email protected]>2018-04-04 13:35:16 +0200
committeralex <[email protected]>2018-04-04 13:35:16 +0200
commit7f09642fa66517fc983f63bb2e414638382a6512 (patch)
tree962ebd70c403fb1d0a11356e1156e83139207534 /src
parentShort-circuit on an error (diff)
downloadserenity-7f09642fa66517fc983f63bb2e414638382a6512.tar.xz
serenity-7f09642fa66517fc983f63bb2e414638382a6512.zip
Fix nsfw related docs (#299)
Diffstat (limited to 'src')
-rw-r--r--src/model/channel/group.rs6
-rw-r--r--src/model/channel/guild_channel.rs14
-rw-r--r--src/model/channel/mod.rs2
-rw-r--r--src/model/channel/private_channel.rs8
-rw-r--r--src/utils/mod.rs4
5 files changed, 15 insertions, 19 deletions
diff --git a/src/model/channel/group.rs b/src/model/channel/group.rs
index 9a371e8..2fc062b 100644
--- a/src/model/channel/group.rs
+++ b/src/model/channel/group.rs
@@ -3,8 +3,8 @@ use model::prelude::*;
#[cfg(feature = "model")]
use builder::{
- CreateMessage,
- EditMessage,
+ CreateMessage,
+ EditMessage,
GetMessages
};
#[cfg(feature = "model")]
@@ -176,7 +176,7 @@ impl Group {
/// **Note**: This method is for consistency. This will always return
/// `false`, due to groups not being considered NSFW.
///
- /// [`utils::is_nsfw`]: ../utils/fn.is_nsfw.html
+ /// [`utils::is_nsfw`]: ../../utils/fn.is_nsfw.html
#[inline]
pub fn is_nsfw(&self) -> bool { false }
diff --git a/src/model/channel/guild_channel.rs b/src/model/channel/guild_channel.rs
index c001b5c..533aaf2 100644
--- a/src/model/channel/guild_channel.rs
+++ b/src/model/channel/guild_channel.rs
@@ -5,10 +5,10 @@ use model::prelude::*;
use CACHE;
#[cfg(feature = "model")]
use builder::{
- CreateInvite,
- CreateMessage,
- EditChannel,
- EditMessage,
+ CreateInvite,
+ CreateMessage,
+ EditChannel,
+ EditMessage,
GetMessages
};
#[cfg(feature = "model")]
@@ -17,8 +17,8 @@ use http::{self, AttachmentType};
use internal::prelude::*;
#[cfg(feature = "model")]
use std::fmt::{
- Display,
- Formatter,
+ Display,
+ Formatter,
Result as FmtResult
};
#[cfg(feature = "model")]
@@ -392,7 +392,7 @@ impl GuildChannel {
///
/// [`ChannelType::Text`]: enum.ChannelType.html#variant.Text
/// [`ChannelType::Voice`]: enum.ChannelType.html#variant.Voice
- /// [`utils::is_nsfw`]: ../utils/fn.is_nsfw.html
+ /// [`utils::is_nsfw`]: ../../utils/fn.is_nsfw.html
#[cfg(feature = "utils")]
#[inline]
pub fn is_nsfw(&self) -> bool {
diff --git a/src/model/channel/mod.rs b/src/model/channel/mod.rs
index 5487a0b..8d586a6 100644
--- a/src/model/channel/mod.rs
+++ b/src/model/channel/mod.rs
@@ -304,7 +304,7 @@ impl Channel {
///
/// Refer to [`utils::is_nsfw`] for more details.
///
- /// [`utils::is_nsfw`]: ../utils/fn.is_nsfw.html
+ /// [`utils::is_nsfw`]: ../../utils/fn.is_nsfw.html
#[cfg(all(feature = "model", feature = "utils"))]
#[inline]
pub fn is_nsfw(&self) -> bool {
diff --git a/src/model/channel/private_channel.rs b/src/model/channel/private_channel.rs
index dc93a7f..91a019c 100644
--- a/src/model/channel/private_channel.rs
+++ b/src/model/channel/private_channel.rs
@@ -1,15 +1,15 @@
use chrono::{DateTime, FixedOffset};
use model::prelude::*;
use std::fmt::{
- Display,
- Formatter,
+ Display,
+ Formatter,
Result as FmtResult
};
use super::deserialize_single_recipient;
#[cfg(feature = "model")]
use builder::{
- CreateMessage,
+ CreateMessage,
EditMessage,
GetMessages
};
@@ -155,7 +155,7 @@ impl PrivateChannel {
/// **Note**: This method is for consistency. This will always return
/// `false`, due to DMs not being considered NSFW.
///
- /// [`utils::is_nsfw`]: ../utils/fn.is_nsfw.html
+ /// [`utils::is_nsfw`]: ../../utils/fn.is_nsfw.html
#[inline]
pub fn is_nsfw(&self) -> bool { false }
diff --git a/src/utils/mod.rs b/src/utils/mod.rs
index 50f6579..002f33f 100644
--- a/src/utils/mod.rs
+++ b/src/utils/mod.rs
@@ -57,10 +57,6 @@ pub fn vecmap_to_json_map<K: PartialEq + ToString>(map: VecMap<K, Value>) -> Map
/// This checks that the name is either `"nsfw"` or, for names longer than that,
/// is prefixed with `"nsfw"`.
///
-/// **Note**: Whether a channel is NSFW is done client-side, as a field for the
-/// NSFW-ness of a channel is not sent to clients. Discord's requirements for
-/// defining a channel as NSFW can change at any time.
-///
/// # Examples
///
/// Check that a channel named `"nsfw"` is in fact NSFW: