Deprecate Client::login, add Client::new

4 files changed, 29 insertions, 24 deletions

diff --git a/src/framework/configuration.rs b/src/framework/configuration.rs
index 1b8df30..0a1c351 100644
--- a/src/framework/configuration.rs
+++ b/src/framework/configuration.rs
@@ -19,7 +19,7 @@ use ::model::{GuildId, UserId};
 /// use serenity::Client;
 /// use std::env;
 ///
-/// let mut client = Client::login(&env::var("DISCORD_BOT_TOKEN").unwrap());
+/// let mut client = Client::new(&env::var("DISCORD_BOT_TOKEN").unwrap());
 ///
 /// client.with_framework(|f| f
 ///     .configure(|c| c.on_mention(true).prefix("~")));
@@ -100,7 +100,7 @@ impl Configuration {
     ///
     /// ```rust
     /// # use serenity::Client;
-    /// # let mut client = Client::login("token");
+    /// # let mut client = Client::new("token");
     /// use serenity::model::GuildId;
     ///
     /// client.with_framework(|f| f.configure(|c| c
@@ -121,7 +121,7 @@ impl Configuration {
     ///
     /// ```rust
     /// # use serenity::Client;
-    /// # let mut client = Client::login("token");
+    /// # let mut client = Client::new("token");
     /// use serenity::model::UserId;
     ///
     /// client.with_framework(|f| f.configure(|c| c
@@ -155,7 +155,7 @@ impl Configuration {
     ///
     /// ```rust
     /// # use serenity::Client;
-    /// # let mut client = Client::login("token");
+    /// # let mut client = Client::new("token");
     ///
     /// let disabled = vec!["ping"].into_iter().map(|x| x.to_owned()).collect();
     ///
@@ -182,7 +182,7 @@ impl Configuration {
     /// ```rust,no_run
     /// # use serenity::Client;
     /// #
-    /// # let mut client = Client::login("token");
+    /// # let mut client = Client::new("token");
     /// client.with_framework(|f| f
     ///     .command("ping", |c| c.exec_str("Pong!"))
     ///     .configure(|c| c.dynamic_prefix(|ctx| {
@@ -261,7 +261,7 @@ impl Configuration {
     ///
     /// ```rust
     /// # use serenity::Client;
-    /// # let mut client = Client::login("token");
+    /// # let mut client = Client::new("token");
     /// use serenity::model::UserId;
     ///
     /// client.with_framework(|f| f.configure(|c| c
@@ -272,7 +272,7 @@ impl Configuration {
     ///
     /// ```rust
     /// # use serenity::Client;
-    /// # let mut client = Client::login("token");
+    /// # let mut client = Client::new("token");
     /// use serenity::model::UserId;
     /// use std::collections::HashSet;
     ///
@@ -288,7 +288,7 @@ impl Configuration {
         self
     }
 
-    /// Sets the prefix to respond to. A prefix can be a string slice of any 
+    /// Sets the prefix to respond to. A prefix can be a string slice of any
     /// non-zero length.
     ///
     /// # Examples
@@ -297,7 +297,7 @@ impl Configuration {
     ///
     /// ```rust
     /// # use serenity::Client;
-    /// # let mut client = Client::login("token");
+    /// # let mut client = Client::new("token");
     /// #
     /// client.with_framework(|f| f.configure(|c| c
     ///     .prefix("!")));
@@ -317,7 +317,7 @@ impl Configuration {
     ///
     /// ```rust
     /// # use serenity::Client;
-    /// # let mut client = Client::login("token");
+    /// # let mut client = Client::new("token");
     /// #
     /// client.with_framework(|f| f.configure(|c| c
     ///     .prefixes(vec!["!", ">", "+"])));
diff --git a/src/framework/create_command.rs b/src/framework/create_command.rs
index a31c91a..9aed52f 100644
--- a/src/framework/create_command.rs
+++ b/src/framework/create_command.rs
@@ -38,7 +38,7 @@ impl CreateCommand {
     /// use serenity::model::Message;
     /// use std::env;
     ///
-    /// let mut client = Client::login(&env::var("DISCORD_TOKEN").unwrap());
+    /// let mut client = Client::new(&env::var("DISCORD_TOKEN").unwrap());
     ///
     /// client.with_framework(|f| f
     ///     .configure(|c| c.prefix("~"))
diff --git a/src/framework/help_commands.rs b/src/framework/help_commands.rs
index a4dbe76..964aa41 100644
--- a/src/framework/help_commands.rs
+++ b/src/framework/help_commands.rs
@@ -10,7 +10,8 @@
 //! use serenity::Client;
 //! use std::env;
 //!
-//! let mut client = Client::login(&env::var("DISCORD_TOKEN").unwrap());
+//! let mut client = Client::new(&env::var("DISCORD_TOKEN").unwrap());
+//!
 //! client.with_framework(|f| f
 //!     .command("help", |c| c.exec_help(help_commands::with_embeds)));
 //! ```
@@ -59,7 +60,9 @@ fn remove_aliases(cmds: &HashMap<String, CommandOrAlias>) -> HashMap<&String, &I
 ///
 /// ```rust
 /// # use serenity::Client;
-/// # let mut client = Client::login("token");
+/// #
+/// # let mut client = Client::new("token");
+/// #
 /// use serenity::ext::framework::help_commands;
 ///
 /// client.with_framework(|f| f
@@ -206,7 +209,9 @@ pub fn with_embeds(ctx: &mut Context,
 ///
 /// ```rust
 /// # use serenity::Client;
-/// # let mut client = Client::login("token");
+/// #
+/// # let mut client = Client::new("token");
+/// #
 /// use serenity::ext::framework::help_commands;
 ///
 /// client.with_framework(|f| f
diff --git a/src/framework/mod.rs b/src/framework/mod.rs
index 20da188..63a83b4 100644
--- a/src/framework/mod.rs
+++ b/src/framework/mod.rs
@@ -36,7 +36,7 @@
 //! use serenity::model::Message;
 //! use std::env;
 //!
-//! let mut client = Client::login(&env::var("DISCORD_BOT_TOKEN").unwrap());
+//! let mut client = Client::new(&env::var("DISCORD_BOT_TOKEN").unwrap());
 //!
 //! client.with_framework(|f| f
 //!     .configure(|c| c.prefix("~"))
@@ -255,7 +255,7 @@ impl Framework {
     /// use serenity::Client;
     /// use std::env;
     ///
-    /// let mut client = Client::login(&env::var("DISCORD_TOKEN").unwrap());
+    /// let mut client = Client::new(&env::var("DISCORD_TOKEN").unwrap());
     /// client.with_framework(|f| f
     ///     .configure(|c| c
     ///         .depth(3)
@@ -285,7 +285,7 @@ impl Framework {
     ///
     /// ```rust
     /// # use serenity::Client;
-    /// # let mut client = Client::login("token");
+    /// # let mut client = Client::new("token");
     /// #
     /// client.with_framework(|f| f
     ///     .bucket("basic", 2, 10, 3)
@@ -314,7 +314,7 @@ impl Framework {
     ///
     /// ```rust
     /// # use serenity::Client;
-    /// # let mut client = Client::login("token");
+    /// # let mut client = Client::new("token");
     /// #
     /// client.with_framework(|f| f
     ///     .simple_bucket("simple", 2)
@@ -593,7 +593,7 @@ impl Framework {
     /// #
     /// # fn main() {
     /// #     use serenity::Client;
-    /// #     let mut client = Client::login("token");
+    /// #     let mut client = Client::new("token");
     /// #
     /// client.with_framework(|f| f.on("ping", ping));
     ///
@@ -671,7 +671,7 @@ impl Framework {
     ///
     /// ```rust
     /// # use serenity::Client;
-    /// # let mut client = Client::login("token");
+    /// # let mut client = Client::new("token");
     /// #
     /// client.with_framework(|f| f
     ///     .group("ping-pong", |g| g
@@ -699,7 +699,7 @@ impl Framework {
     ///
     /// ```rust
     /// # use serenity::Client;
-    /// # let mut client = Client::login("token");
+    /// # let mut client = Client::new("token");
     /// use serenity::framework::DispatchError::{NotEnoughArguments, TooManyArguments};
     ///
     /// client.with_framework(|f| f
@@ -735,7 +735,7 @@ impl Framework {
     ///
     /// ```rust
     /// # use serenity::Client;
-    /// # let mut client = Client::login("token");
+    /// # let mut client = Client::new("token");
     /// #
     /// client.with_framework(|f| f
     ///     .before(|ctx, msg, cmd_name| {
@@ -748,7 +748,7 @@ impl Framework {
     ///
     /// ```rust
     /// # use serenity::Client;
-    /// # let mut client = Client::login("token");
+    /// # let mut client = Client::new("token");
     /// #
     /// client.with_framework(|f| f
     ///     .before(|_, msg, cmd_name| {
@@ -781,7 +781,7 @@ impl Framework {
     ///
     /// ```rust
     /// # use serenity::Client;
-    /// # let mut client = Client::login("token");
+    /// # let mut client = Client::new("token");
     /// #
     /// client.with_framework(|f| f
     ///     .after(|ctx, msg, cmd_name, error| {