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

Auto merge of #938 - Kalwyn:master, r=kbknapp

Browse source 
docs(README.md): fix some typos

This is the first time i make a pull request. I hope i have done things right.
I love clap-rs very much. Thank you for your hard work.

<!-- Reviewable:start -->
---
This change is [<img src="https://reviewable.io/review_button.svg" height="34" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/kbknapp/clap-rs/938)
<!-- Reviewable:end -->
This commit is contained in:
Homu 2017-04-23 09:48:45 +09:00
commit 448ba6a6f0
1 changed files with 18 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -86,7 +86,7 @@ Here's the highlights for v2.21.0 to v2.22.2
* fixes some regression bugs resulting from old asserts in debug mode.
* adds the ability to mark a positional argument as 'last' which means it should be used with `--` syntax and can be accessed early to effectivly skip other positional args
* Some performance improvements by reducing the ammount of duplicate work, cloning, and allocations in all cases.
* Some massive perfomance gains when using many args (i.e. things like shell glob expansions)
* Some massive performance gains when using many args (i.e. things like shell glob expansions)
* adds a setting to allow one to infer shortened subcommands or aliases (i.e. for subcommmand "test", "t", "te", or "tes" would be allowed assuming no other ambiguities)
* when `AppSettings::SubcommandsNegateReqs` and `ArgsNegateSubcommands` are used, a new more accurate double line usage string is shown
* provides `default_value_os` and `default_value_if[s]_os`
@ -470,7 +470,7 @@ Then run `cargo build` or `cargo update && cargo build` for your project.
* **"suggestions"**: Turns on the `Did you mean '--myoption'?` feature for when users make typos. (builds dependency `strsim`)
* **"color"**: Turns on colored error messages. This feature only works on non-Windows OSs. (builds dependency `ansi-term`)
* **"wrap_help"**: Wraps the help at the actual terminal width when available, instead of 120 chracters. (builds dependency `term_size`)
* **"wrap_help"**: Wraps the help at the actual terminal width when available, instead of 120 characters. (builds dependency `term_size`)
To disable these, add this to your `Cargo.toml`:
@ -529,14 +529,14 @@ Please read [CONTRIBUTING.md](.github/CONTRIBUTING.md) before you start contribu
### Testing Code
To test with all features both enabled and disabled, you can run theese commands:
To test with all features both enabled and disabled, you can run these commands:
```sh
$ cargo test --no-default-features
$ cargo test --features "yaml unstable"
```
Alternatively, if you have [`just`](https://github.com/casey/just) installed you can run the prebuilt recipies. *Not* using `just` is prfeclty fine as well, it simply bundles commands automatically.
Alternatively, if you have [`just`](https://github.com/casey/just) installed you can run the prebuilt recipes. *Not* using `just` is perfectly fine as well, it simply bundles commands automatically.
For example, to test the code, as above simply run:
@ -606,7 +606,7 @@ Because `clap` takes SemVer and compatibility seriously, this is the official po
`clap` will pin the minimum required version of Rust to the CI builds. Bumping the minimum version of Rust is considered a minor breaking change, meaning *at a minimum* the minor version of `clap` will be bumped.
In order to keep from being suprised of breaking changes, it is **highly** recommended to use the `~major.minor.patch` style in your `Cargo.toml` only if you wish to target a version of Rust that is *older* than current stable minus two releases:
In order to keep from being surprised of breaking changes, it is **highly** recommended to use the `~major.minor.patch` style in your `Cargo.toml` only if you wish to target a version of Rust that is *older* than current stable minus two releases:
```toml
[dependencies]
@ -624,7 +624,7 @@ Upon bumping the minimum version of Rust (assuming it's within the stable-2 rang
#### Breaking Changes
`clap` takes a similar policy to Rust and will bump the major veresion number upon breaking changes with only the following exceptions:
`clap` takes a similar policy to Rust and will bump the major version number upon breaking changes with only the following exceptions:
* The breaking change is to fix a security concern
* The breaking change is to be fixing a bug (i.e. relying on a bug as a feature)