Mirrors/clap
2
0
Fork 0
mirror of https://github.com/clap-rs/clap synced 2024-12-13 14:22:34 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs: fixes some typo mistakes

Browse source
This commit is contained in:
Kevin K 2017-10-24 20:30:11 -04:00
parent e3eaf56b36
commit 3a471b72ce
No known key found for this signature in database
GPG key ID: 17218E4B3692F01A
2 changed files with 41 additions and 45 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -72,7 +72,7 @@ See the commit [0c223f54](https://github.com/kbknapp/clap-rs/commit/0c223f54ed46
* fixes when an argument requires a value and that value happens to match a subcommand name, its parsed as a value
* **AppSettings::PropagateGlobalValuesDown:** this setting deprecated and is no longer required to propagate values down or up
Here's what's new in 2.26.2:
Here's the highlights for v2.21.0 to v2.26.2
* if all subcommands are hidden, the subcommands section of the help message is no longer displayed
* fixes a bug where default values are not applied if the option supports zero values
@ -82,10 +82,6 @@ Here's what's new in 2.26.2:
* Change `who's` -> `whose` in documentation
* **Help Message:** fixes `App::long_about` not being displayed
* **Suggestions:** output for flag after subcommand
Here's the highlights for v2.21.0 to v2.26.0
* **The minimum required version of Rust is now 1.13.0 (Stable)**
* bumps unicode-segmentation to v1.2
* update textwrap to version 0.7.0 which increases the performance of writing help strings
@ -380,7 +376,7 @@ subcommands:
Since this feature requires additional dependencies that not everyone may want, it is *not* compiled in by default and we need to enable a feature flag in Cargo.toml:
Simply change your `clap = "2.19"` to `clap = {version = "2.19", features = ["yaml"]}`.
Simply change your `clap = "2.27"` to `clap = {version = "2.27", features = ["yaml"]}`.
At last we create our `main.rs` file just like we would have with the previous two examples:
@ -499,7 +495,7 @@ For full usage, add `clap` as a dependency in your `Cargo.toml` () to use from c
```toml
[dependencies]
clap = "~2.26"
clap = "~2.27"
```
(**note**: If you are concerned with supporting a minimum version of Rust that is *older* than the current stable Rust minus 2 stable releases, it's recommended to use the `~major.minor.patch` style versions in your `Cargo.toml` which will only update the patch version automatically. For more information see the [Compatibility Policy](#compatibility-policy))
@ -523,7 +519,7 @@ To disable these, add this to your `Cargo.toml`:
```toml
[dependencies.clap]
version = "2.26"
version = "2.27"
default-features = false
```
@ -531,7 +527,7 @@ You can also selectively enable only the features you'd like to include, by addi
```toml
[dependencies.clap]
version = "2.26"
version = "2.27"
default-features = false
# Cherry-pick the features you'd like to use
@ -657,7 +653,7 @@ In order to keep from being surprised of breaking changes, it is **highly** reco
```toml
[dependencies]
clap = "~2.26"
clap = "~2.27"
```
This will cause *only* the patch version to be updated upon a `cargo update` call, and therefore cannot break due to new features, or bumped minimum versions of Rust.
@ -686,7 +682,7 @@ This is inherently an unresolvable crate graph in Cargo right now. Cargo require
#### Minimum Version of Rust
`clap` will officially support current stable Rust, minus two releases, but may work with prior releases as well. For example, current stable Rust at the time of this writing is 1.19.0, meaning `clap` is guaranteed to compile with 1.19.0 and beyond.
`clap` will officially support current stable Rust, minus two releases, but may work with prior releases as well. For example, current stable Rust at the time of this writing is 1.21.0, meaning `clap` is guaranteed to compile with 1.19.0 and beyond.
At the 1.22.0 stable release, `clap` will be guaranteed to compile with 1.20.0 and beyond, etc.

18
src/lib.rs
View file

@ -180,7 +180,7 @@
//! Since this feature requires additional dependencies that not everyone may want, it is *not*
//! compiled in by default and we need to enable a feature flag in Cargo.toml:
//!
//! Simply change your `clap = "~2.19.0"` to `clap = {version = "~2.19.0", features = ["yaml"]}`.
//! Simply change your `clap = "~2.27.0"` to `clap = {version = "~2.27.0", features = ["yaml"]}`.
//!
//! At last we create our `main.rs` file just like we would have with the previous two examples:
//!
@ -306,7 +306,7 @@
//!
//! ```toml
//! [dependencies]
//! clap = "~2.19.0"
//! clap = "~2.27.0"
//! ```
//!
//! Or get the latest changes from the master branch at github:
@ -337,7 +337,7 @@
//!
//! ```toml
//! [dependencies.clap]
//! version = "~2.19.0"
//! version = "~2.27.0"
//! default-features = false
//! ```
//!
@ -345,7 +345,7 @@
//!
//! ```toml
//! [dependencies.clap]
//! version = "~2.19.0"
//! version = "~2.27.0"
//! default-features = false
//!
//! # Cherry-pick the features you'd like to use
@ -491,7 +491,7 @@
//! the `~major.minor.patch` style in your `Cargo.toml`:
//!
//! ```toml
//! [dependencies] clap = "~2.19.0"
//! [dependencies] clap = "~2.27.0"
//! ```
//!
//! This will cause *only* the patch version to be updated upon a `cargo update` call, and therefore
@ -500,9 +500,9 @@
//! #### Minimum Version of Rust
//!
//! `clap` will officially support current stable Rust, minus two releases, but may work with prior
//! releases as well. For example, current stable Rust at the time of this writing is 1.13.0,
//! meaning `clap` is guaranteed to compile with 1.11.0 and beyond. At the 1.14.0 release, `clap`
//! will be guaranteed to compile with 1.12.0 and beyond, etc.
//! releases as well. For example, current stable Rust at the time of this writing is 1.21.0,
//! meaning `clap` is guaranteed to compile with 1.19.0 and beyond. At the 1.22.0 release, `clap`
//! will be guaranteed to compile with 1.20.0 and beyond, etc.
//!
//! Upon bumping the minimum version of Rust (assuming it's within the stable-2 range), it *must* be
//! clearly annotated in the `CHANGELOG.md`
@ -513,7 +513,7 @@
//! this repository for more information.
#![crate_type= "lib"]
#![doc(html_root_url = "https://docs.rs/clap/2.26.2")]
#![doc(html_root_url = "https://docs.rs/clap/2.27.0")]
#![deny(
missing_docs,
missing_debug_implementations,