docs(clap): update docs

src/args/subcommand.rs

@@ -21,8 +21,10 @@ use ArgMatches;
 ///                           .index(1))
 /// # ).get_matches();
 pub struct SubCommand<'n, 'a> {
-       pub name: &'n str,
-       pub matches: ArgMatches<'n, 'a>
+    #[doc(hidden)]
+    pub name: &'n str,
+    #[doc(hidden)]
+    pub matches: ArgMatches<'n, 'a>
 }
 
 impl<'n, 'a> SubCommand<'n, 'a> {

src/lib.rs

@@ -30,10 +30,13 @@
 //!   - Optionally supports multiple values (i.e. `myprog <file>...` such as `myprog file1.txt file2.txt` being two values for the same "file" argument)
 //!   - Optionally supports Specific Value Sets (See below)
 //!   - Supports the unix `--` meaning, only positional arguments follow
+//!   - Optionally sets value parameters (such as the minimum number of values, the maximum number of values, or the exact number of values)
 //! * **Option Arguments** (i.e. those that take values as options)
 //!   - Both short and long versions supported (i.e. `-o value` and `--option value` or `--option=value` respectively)
-//!   - Optionally supports multiple values (i.e. `-o <value> -o <other_value>`)
+//!   - Optionally supports multiple values (i.e. `-o <value> -o <other_value>` or the shorthand `-o <value> <other_value>`)
 //!   - Optionally supports Specific Value Sets (See below)
+//!   - Optionally supports named values so that the usage/help info appears as `-o <name> <other_name>` etc. for when you require specific multiple values
+//!   - Optionally sets value parameters (such as the minimum number of values, the maximum number of values, or the exact number of values)
 //! * **Sub-Commands** (i.e. `git add <file>` where `add` is a sub-command of `git`)
 //!   - Support their own sub-arguments, and sub-sub-commands independant of the parent
 //!   - Get their own auto-generated Help, Version, and Usage independant of parent
@@ -57,7 +60,7 @@
 //!  
 //!  *NOTE:* Both examples are functionally the same, but show two different styles in which to use `clap`
 //!  
-//! ```no_run
+//! ```rust
 //! // (Full example with detailed comments in examples/01a_QuickExample.rs)
 //! //
 //! // This example demonstrates clap's "usage strings" method of creating arguments which is less
@@ -114,7 +117,7 @@
 //! 
 //! The following example is functionally the same as the one above, but this method allows more advanced configuration options (not shown in this small example), or even dynamically generating arguments when desired. Both methods can be used together to get the best of both worlds (see the documentation, examples, or video tutorials).
 //!  
-//! ```no_run
+//! ```rust
 //! // (Full example with detailed comments in examples/01b_QuickExample.rs)
 //! //
 //! // This example demonstrates clap's full 'builder pattern' style of creating arguments which is 
@@ -183,7 +186,7 @@
 //! 
 //! If you were to compile either of the above programs and run them with the flag `--help` or `-h` (or `help` subcommand, since we defined `test` as a subcommand) the following would be output
 //! 
-//! ```ignore
+//! ```sh
 //! $ myapp --help
 //! myapp 1.0
 //! Kevin K. <kbknapp@gmail.com>
@@ -227,14 +230,14 @@
 //! * Create a new cargo project `$ cargo new fake --bin && cd fake`
 //! * Add `clap` to your `Cargo.toml`
 //! * 
-//! ```ignore
+//! ```toml
 //! [dependencies]
 //! clap = "*"
 //! ```
 //! 
 //! * Add the following to your `src/main.rs`
 //! 
-//! ```no_run
+//! ```rust
 //! extern crate clap;
 //! use clap::App;
 //! 
@@ -299,7 +302,7 @@
 //! 
 //! If contributing, you can run the tests as follows (assuming you've cloned the repo to `clap-rs/`
 //! 
-//! ```ignore
+//! ```
 //! cd clap-rs && cargo test
 //! cd clap-tests && make test
 //! ```
@@ -321,6 +324,30 @@
 //! ## License
 //! 
 //! `clap` is licensed under the MIT license. Please the LICENSE-MIT file in this repository for more information.
+//! 
+//! ## Recent Breaking Changes
+//! 
+//! Although I do my best to keep breaking changes to a minimum, being that this a sub 1.0 library, there are breaking changes from time to time in order to support better features or implementation. For the full details see the changelog.md
+//! 
+//! * As of 0.7.0
+//!   - `Arg::possible_values()`, `Arg::value_names()`, `Arg::requires_all()`, `Arg::mutually_excludes_all()` [deprecated], `Arg::conflicts_with_all()`
+//!     + No longer take a `Vec<&str>`, instead they take a generic `IntoIterator<Item=AsRef<str>>` which means you cannot use an inline `vec![]` but it means the methods are now far more flexible, especially for dynamic value generation.
+//!     + Instead use something that conforms to the `IntoIterator` trait, or something like:
+//!     
+//!     ```rust
+//!     let my_vals = ["value1", "value2", "value3"];
+//!     ...
+//!     .possible_values(&my_vals)
+//!     ```
+//! 
+//! ### Deprecations
+//! 
+//! Old method names will be left around for some time.
+//! 
+//! * As of 0.6.8
+//!   - `Arg::new()` -> `Arg::with_name()`
+//!   - `Arg::mutually_excludes()` -> `Arg::conflicts_with()`
+//!   - `Arg::mutually_excludes_all()` -> `Arg::conflicts_with_all()`
 
 pub use args::{Arg, SubCommand, ArgMatches, ArgGroup};
 pub use app::App;