diff options
| author | acdenisSK <[email protected]> | 2017-11-08 14:12:51 +0100 |
|---|---|---|
| committer | acdenisSK <[email protected]> | 2017-11-08 14:12:51 +0100 |
| commit | 3845681cfd32cabc74665f93427c1f2da379c01f (patch) | |
| tree | 9758f41071b9d869a3bc8b9d132d0a92e8e9697b /src | |
| parent | Fix indention for the docs (#213) (diff) | |
| download | serenity-3845681cfd32cabc74665f93427c1f2da379c01f.tar.xz serenity-3845681cfd32cabc74665f93427c1f2da379c01f.zip | |
Fix doc-tests
Diffstat (limited to 'src')
| -rw-r--r-- | src/builder/create_embed.rs | 4 | ||||
| -rw-r--r-- | src/builder/create_invite.rs | 2 | ||||
| -rw-r--r-- | src/cache/mod.rs | 10 | ||||
| -rw-r--r-- | src/gateway/shard.rs | 52 |
4 files changed, 15 insertions, 53 deletions
diff --git a/src/builder/create_embed.rs b/src/builder/create_embed.rs index 06834f9..2079230 100644 --- a/src/builder/create_embed.rs +++ b/src/builder/create_embed.rs @@ -235,9 +235,9 @@ impl CreateEmbed { /// struct Handler; /// /// impl EventHandler for Handler { - /// fn on_guild_member_addition(&self, _: Context, guild_id: GuildId, member: Member) { + /// fn guild_member_addition(&self, _: Context, guild_id: GuildId, member: Member) { /// use serenity::CACHE; - /// let cache = CACHE.read().unwrap(); + /// let cache = CACHE.read(); /// /// if let Some(guild) = cache.guild(guild_id) { /// let guild = guild.read(); diff --git a/src/builder/create_invite.rs b/src/builder/create_invite.rs index 0b05b66..ef81faa 100644 --- a/src/builder/create_invite.rs +++ b/src/builder/create_invite.rs @@ -19,7 +19,7 @@ use internal::prelude::*; /// struct Handler; /// /// impl EventHandler for Handler { -/// fn on_message(&self, _: Context, msg: Message) { +/// fn message(&self, _: Context, msg: Message) { /// use serenity::CACHE; /// if msg.content == "!createinvite" { /// let channel = match CACHE.read().guild_channel(msg.channel_id) { diff --git a/src/cache/mod.rs b/src/cache/mod.rs index e23e17e..331c21a 100644 --- a/src/cache/mod.rs +++ b/src/cache/mod.rs @@ -272,8 +272,8 @@ impl Cache { /// struct Handler; /// /// impl EventHandler for Handler { - /// fn on_ready(&self, _: Context, _: Ready) { - /// let guilds = CACHE.read().unwrap().guilds.len(); + /// fn ready(&self, _: Context, _: Ready) { + /// let guilds = CACHE.read().guilds.len(); /// /// println!("Guilds in the Cache: {}", guilds); /// } @@ -525,11 +525,11 @@ impl Cache { /// # fn try_main() -> Result<(), Box<Error>> { /// use serenity::CACHE; /// - /// let cache = CACHE.read()?; + /// let cache = CACHE.read(); /// /// if let Some(channel) = cache.private_channel(7) { - /// let channel_reader = channel.read().unwrap(); - /// let user_reader = channel_reader.recipient.read().unwrap(); + /// let channel_reader = channel.read(); + /// let user_reader = channel_reader.recipient.read(); /// /// println!("The recipient is {}", user_reader.name); /// } diff --git a/src/gateway/shard.rs b/src/gateway/shard.rs index 08a26a6..cd502d7 100644 --- a/src/gateway/shard.rs +++ b/src/gateway/shard.rs @@ -290,7 +290,8 @@ impl Shard { /// # #[cfg(feature = "model")] /// # fn main() { /// # use serenity::client::gateway::Shard; - /// # use std::sync::{Arc, Mutex}; + /// # use std::sync::Arc; + /// # use serenity::prelude::Mutex; /// # /// # let mutex = Arc::new(Mutex::new("".to_string())); /// # @@ -337,28 +338,24 @@ impl Shard { /// Retrieving the shard info for the second shard, out of two shards total: /// /// ```rust,no_run - /// # extern crate parking_lot; /// # extern crate serenity; - /// # - /// # use parking_lot::Mutex; /// # #[cfg(feature = "model")] /// # fn main() { /// # use serenity::client::gateway::Shard; + /// # use serenity::prelude::Mutex; /// # use std::error::Error; /// # use std::sync::Arc; /// # - /// # fn try_main() -> Result<(), Box<Error>> { - /// # let mutex = Arc::new(Mutex::new("".to_string())); + /// # let mutex = Arc::new(Mutex::new("".to_string())); /// # - /// # let shard = Shard::new(mutex.clone(), mutex, [1, 2]).unwrap(); + /// # let shard = Shard::new(mutex.clone(), mutex, [1, 2]).unwrap(); /// # /// assert_eq!(shard.shard_info(), [1, 2]); /// # Ok(()) /// # } /// # - /// # fn main() { - /// # try_main().unwrap(); - /// # } + /// # #[cfg(not(feature = "model")] + /// # fn main() {} /// ``` pub fn shard_info(&self) -> [u64; 2] { self.shard_info } @@ -649,41 +646,6 @@ impl Shard { } /// Calculates the heartbeat latency between the shard and the gateway. - /// - /// # Examples - /// - /// When using the [`Client`], output the latency in response to a `"~ping"` - /// message handled through [`Client::on_message`]. - /// - /// ```rust,no_run - /// # #[cfg(feature = "model")] - /// # fn main() { - /// # use serenity::prelude::*; - /// # use serenity::model::*; - /// struct Handler; - /// - /// impl EventHandler for Handler { - /// fn on_message(&self, ctx: Context, msg: Message) { - /// if msg.content == "~ping" { - /// if let Some(latency) = ctx.shard.lock().latency() { - /// let s = format!("{}.{}s", latency.as_secs(), latency.subsec_nanos()); - /// - /// let _ = msg.channel_id.say(&s); - /// } else { - /// let _ = msg.channel_id.say("N/A"); - /// } - /// } - /// } - /// } - /// let mut client = Client::new("token", Handler); client.start().unwrap(); - /// # } - /// # - /// # #[cfg(not(feature = "model"))] - /// # fn main() { } - /// ``` - /// - /// [`Client`]: ../struct.Client.html - /// [`EventHandler::on_message`]: ../event_handler/trait.EventHandler.html#method.on_message // Shamelessly stolen from brayzure's commit in eris: // <https://github.com/abalabahaha/eris/commit/0ce296ae9a542bcec0edf1c999ee2d9986bed5a6> pub fn latency(&self) -> Option<StdDuration> { |