Skip to content

Commit

Permalink
Turn some ignore'd doctests of Client to no_runs (#484)
Browse files Browse the repository at this point in the history
This will compile, but not execute them.
  • Loading branch information
MOZGIII authored and arqunis committed Feb 17, 2019
1 parent 201bc56 commit 00990c0
Showing 1 changed file with 29 additions and 26 deletions.
55 changes: 29 additions & 26 deletions src/client/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -73,23 +73,26 @@ use self::bridge::voice::ClientVoiceManager;
/// Creating a Client instance and adding a handler on every message
/// receive, acting as a "ping-pong" bot is simple:
///
/// ```rust,ignore
/// ```no_run
/// # fn main() -> Result<(), Box<std::error::Error>> {
/// use serenity::prelude::*;
/// use serenity::model::*;
/// use serenity::model::prelude::*;
/// use serenity::Client;
///
/// struct Handler;
///
/// impl EventHandler for Handler {
/// fn on_message(&self, _: Context, msg: Message) {
/// fn message(&self, _: Context, msg: Message) {
/// if msg.content == "!ping" {
/// let _ = msg.channel_id.say("Pong!");
/// }
/// }
/// }
///
/// let mut client = Client::new("my token here", Handler);
/// let mut client = Client::new("my token here", Handler)?;
///
/// client.start();
/// # Ok(()) }
/// ```
///
/// [`Shard`]: ../gateway/struct.Shard.html
Expand Down Expand Up @@ -118,12 +121,13 @@ pub struct Client {
/// - [`Event::MessageDeleteBulk`]
/// - [`Event::MessageUpdate`]
///
/// ```rust,ignore
/// ```no_run
/// # fn main() -> Result<(), Box<std::error::Error>> {
/// extern crate serenity;
///
/// // Of note, this imports `typemap`'s `Key` as `TypeMapKey`.
/// use serenity::prelude::*;
/// use serenity::model::*;
/// use serenity::model::prelude::*;
/// use std::collections::HashMap;
/// use std::env;
///
Expand All @@ -133,37 +137,36 @@ pub struct Client {
/// type Value = HashMap<String, u64>;
/// }
///
/// macro_rules! reg {
/// ($ctx:ident $name:expr) => {
/// {
/// let mut data = $ctx.data.lock();
/// let counter = data.get_mut::<MessageEventCounter>().unwrap();
/// let entry = counter.entry($name).or_insert(0);
/// *entry += 1;
/// }
/// };
/// fn reg<S>(ctx: Context, name: S)
/// where S: Into<std::string::String>
/// {
/// let mut data = ctx.data.lock();
/// let counter = data.get_mut::<MessageEventCounter>().unwrap();
/// let entry = counter.entry(name.into()).or_insert(0);
/// *entry += 1;
/// }
///
/// struct Handler;
///
/// impl EventHandler for Handler {
/// fn on_message(&self, ctx: Context, _: Message) { reg!(ctx "MessageCreate") }
/// fn on_message_delete(&self, ctx: Context, _: ChannelId, _: MessageId) {
/// reg!(ctx "MessageDelete") }
/// fn on_message_delete_bulk(&self, ctx: Context, _: ChannelId, _: Vec<MessageId>) {
/// reg!(ctx "MessageDeleteBulk") }
/// fn on_message_update(&self, ctx: Context, _: ChannelId, _: MessageId) {
/// reg!(ctx "MessageUpdate") }
/// fn message(&self, ctx: Context, _: Message) { reg(ctx, "MessageCreate") }
/// fn message_delete(&self, ctx: Context, _: ChannelId, _: MessageId) {
/// reg(ctx, "MessageDelete") }
/// fn message_delete_bulk(&self, ctx: Context, _: ChannelId, _: Vec<MessageId>) {
/// reg(ctx, "MessageDeleteBulk") }
/// fn message_update(&self, ctx: Context, _: MessageUpdateEvent) {
/// reg(ctx, "MessageUpdate") }
/// }
///
/// let mut client = Client::new(&env::var("DISCORD_TOKEN").unwrap(), Handler);
/// let mut client = Client::new(&env::var("DISCORD_TOKEN")?, Handler)?;
///
/// {
/// let mut data = client.data.lock();
/// data.insert::<MessageEventCounter>(HashMap::default());
/// }
///
/// client.start().unwrap();
/// client.start()?;
/// # Ok(()) }
/// ```
///
/// Refer to [example 05] for an example on using the `data` field.
Expand Down Expand Up @@ -747,7 +750,7 @@ impl Client {
///
/// For a bot using a total of 10 shards, initialize shards 4 through 7:
///
/// ```rust,ignore
/// ```no_run
/// # use serenity::prelude::EventHandler;
/// struct Handler;
///
Expand All @@ -756,7 +759,7 @@ impl Client {
/// use std::env;
///
/// let token = env::var("DISCORD_TOKEN").unwrap();
/// let mut client = Client::new(&token, Handler);
/// let mut client = Client::new(&token, Handler).unwrap();
///
/// let _ = client.start_shard_range([4, 7], 10);
/// ```
Expand Down

0 comments on commit 00990c0

Please sign in to comment.