Skip to content

Commit f22c21b

Browse files
committed
docs(README.md): fix some typos
1 parent 5c9b0d4 commit f22c21b

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -54,15 +54,15 @@ Here's the highlights for v2.19.2
5454

5555
Here's the highlights from v2.0.0 to v2.19.1
5656

57-
* **Bash Completion:** allows bash completion to fall back to traidtional bash completion upon no matching completing function
57+
* **Bash Completion:** allows bash completion to fall back to traditional bash completion upon no matching completing function
5858
* **Arg Setting**: Allows specifying an `AllowLeadingHyphen` style setting for values only for specific args, vice command wide
5959
* **Validators:** improves the error messages for validators
6060
* **Required Unless:** fixes a bug where having required_unless set doesn't work when conflicts are also set
6161
* **ZSH Completions:** fixes an issue where zsh completions caused panics if there were no subcommands
6262
* **Completions:** Adds completion support for Microsoft PowerShell! (Thanks to @Arnavion)
6363
* Allows specifying the second to last positional argument as `multiple(true)` (i.e. things such as `mv <files>... <target>`)
6464
* Adds an `App::get_name` and `App::get_bin_name`
65-
* Conflicting argument errors are now symetrical, meaning more consistent and better usage suggestions
65+
* Conflicting argument errors are now symmetrical, meaning more consistent and better usage suggestions
6666
* **Completions:** adds automatic ZSH completion script generation support! :tada: :tada:
6767
* **AppSettings:** adds new setting `AppSettings::AllowNegativeNumbers` which functions like `AllowLeadingHyphen` except only allows undefined negative numbers to pass parsing.
6868
* Stabilize `clap_app!` macro (i.e. no longer need to use `unstable` feature)
@@ -104,7 +104,7 @@ Here's the highlights from v2.0.0 to v2.19.1
104104
* Allows adding multiple ArgGroups per Arg
105105
* **Global Settings:** One can now set an `AppSetting` which is propogated down through child subcommands
106106
* **Terminal Wrapping:** Allows wrapping at specified term width (Even on Windows!) (can now set an absolute width to "smart" wrap at)
107-
* **SubCommands/Aliases:** adds support for visible aliases for subcommands (i.e. aliases that are dipslayed in the help message)
107+
* **SubCommands/Aliases:** adds support for visible aliases for subcommands (i.e. aliases that are displayed in the help message)
108108
* **Subcommands/Aliases:** when viewing the help of an alias, it now display help of the aliased subcommand
109109
* Adds new setting to stop delimiting values with `--` or `AppSettings::TrailingVarArg`
110110
* Subcommands now support aliases - think of them as hidden subcommands that dispatch to said subcommand automatically
@@ -504,7 +504,7 @@ Then run `cargo build` or `cargo update && cargo build` for your project.
504504

505505
* **"suggestions"**: Turns on the `Did you mean '--myoption'?` feature for when users make typos. (builds dependency `strsim`)
506506
* **"color"**: Turns on colored error messages. This feature only works on non-Windows OSs. (builds dependency `ansi-term` and `libc`)
507-
* **"wrap_help"**: Wraps the help at the actual terminal width when available, instead of 120 chracters. (builds dependency `term_size`, and `libc`)
507+
* **"wrap_help"**: Wraps the help at the actual terminal width when available, instead of 120 characters. (builds dependency `term_size`, and `libc`)
508508

509509
To disable these, add this to your `Cargo.toml`:
510510

@@ -563,14 +563,14 @@ Please read [CONTRIBUTING.md](.github/CONTRIBUTING.md) before you start contribu
563563

564564
### Testing Code
565565

566-
To test with all features both enabled and disabled, you can run theese commands:
566+
To test with all features both enabled and disabled, you can run these commands:
567567

568568
```sh
569569
$ cargo test --no-default-features
570570
$ cargo test --features "yaml unstable"
571571
```
572572

573-
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.
573+
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.
574574

575575
For example, to test the code, as above simply run:
576576

@@ -640,7 +640,7 @@ Because `clap` takes SemVer and compatibility seriously, this is the official po
640640

641641
`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.
642642

643-
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:
643+
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:
644644

645645
```toml
646646
[dependencies]
@@ -651,14 +651,14 @@ This will cause *only* the patch version to be updated upon a `cargo update` cal
651651

652652
#### Minimum Version of Rust
653653

654-
`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 garunteed to compile with 1.11.0 and beyond.
655-
At the 1.14.0 release, `clap` will be garunteed to compile with 1.12.0 and beyond, etc.
654+
`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.
655+
At the 1.14.0 release, `clap` will be guaranteed to compile with 1.12.0 and beyond, etc.
656656

657657
Upon bumping the minimum version of Rust (assuming it's within the stable-2 range), it *must* be clearly annotated in the `CHANGELOG.md`
658658

659659
#### Breaking Changes
660660

661-
`clap` takes a similar policy to Rust and will bump the major veresion number upon breaking changes with only the following exceptions:
661+
`clap` takes a similar policy to Rust and will bump the major version number upon breaking changes with only the following exceptions:
662662

663663
* The breaking change is to fix a security concern
664664
* The breaking change is to be fixing a bug (i.e. relying on a bug as a feature)

0 commit comments

Comments
 (0)