Fix typos and grammar

Some more fixes in addition to 594c535ba2
* Some I noticed manually.
* Some were found by Topy (https://github.com/intgr/topy), either new
  rules from Typo or new code in clap.
* `etc.` and `e.g.` rules were disabled during the last run.
This commit is contained in:
Marti Raudsepp 2020-10-09 01:27:13 +03:00
parent 34551bb23d
commit cda89a2af1
8 changed files with 13 additions and 13 deletions

View file

@ -78,7 +78,7 @@ I use a [conventional](https://github.com/ajoslin/conventional-changelog/blob/a5
- `refactor` - Code functionality doesn't change, but underlying structure may - `refactor` - Code functionality doesn't change, but underlying structure may
- `style` - Stylistic changes only, no functionality changes - `style` - Stylistic changes only, no functionality changes
- `wip` - A work in progress commit (Should typically be `git rebase`'ed away) - `wip` - A work in progress commit (Should typically be `git rebase`'ed away)
- `chore` - Catch all or things that have to do with the build system, etc - `chore` - Catch all or things that have to do with the build system, etc.
- `examples` - Changes to existing example, or a new example - `examples` - Changes to existing example, or a new example
* The `COMPONENT` is optional, and may be a single file, directory, or logical component. Parenthesis can be omitted if you are opting not to use the `COMPONENT`. * The `COMPONENT` is optional, and may be a single file, directory, or logical component. Parenthesis can be omitted if you are opting not to use the `COMPONENT`.

View file

@ -437,7 +437,7 @@ impl<'help> App<'help> {
/// ```no_run /// ```no_run
/// # use clap::App; /// # use clap::App;
/// App::new("myprog") /// App::new("myprog")
/// .help_about("Print help information") // Impertive tone /// .help_about("Print help information") // Imperative tone
/// # ; /// # ;
/// ``` /// ```
pub fn help_about<S: Into<&'help str>>(mut self, help_about: S) -> Self { pub fn help_about<S: Into<&'help str>>(mut self, help_about: S) -> Self {
@ -447,7 +447,7 @@ impl<'help> App<'help> {
/// Sets the help text for the auto-generated version argument. /// Sets the help text for the auto-generated version argument.
/// ///
/// By default clap sets this to "Prints versoin information" but if /// By default clap sets this to "Prints version information" but if
/// you're using a different convention for your help messages and /// you're using a different convention for your help messages and
/// would prefer a different phrasing you can override it. /// would prefer a different phrasing you can override it.
/// ///
@ -458,7 +458,7 @@ impl<'help> App<'help> {
/// ```no_run /// ```no_run
/// # use clap::App; /// # use clap::App;
/// App::new("myprog") /// App::new("myprog")
/// .version_about("Print version information") // Impertive tone /// .version_about("Print version information") // Imperative tone
/// # ; /// # ;
/// ``` /// ```
pub fn version_about<S: Into<&'help str>>(mut self, version_about: S) -> Self { pub fn version_about<S: Into<&'help str>>(mut self, version_about: S) -> Self {
@ -1381,7 +1381,7 @@ impl<'help> App<'help> {
/// Replaces an argument or subcommand used on the CLI at runtime with other arguments or subcommands. /// Replaces an argument or subcommand used on the CLI at runtime with other arguments or subcommands.
/// ///
/// When this method is used, `name` is removed from the CLI, and `target` /// When this method is used, `name` is removed from the CLI, and `target`
/// is inserted in it's place. Parsing continues as if the user typed /// is inserted in its place. Parsing continues as if the user typed
/// `target` instead of `name`. /// `target` instead of `name`.
/// ///
/// This can be used to create "shortcuts" for subcommands, or if a /// This can be used to create "shortcuts" for subcommands, or if a
@ -2631,7 +2631,7 @@ impl<'help> App<'help> {
// Unfortunately, that would trigger // Unfortunately, that would trigger
// https://github.com/rust-lang/rust/issues/34511#issuecomment-373423999 // https://github.com/rust-lang/rust/issues/34511#issuecomment-373423999
// //
// I think this "collect to vec" solution is better then the linked one // I think this "collect to vec" solution is better than the linked one
// because it's simpler and it doesn't really matter performance-wise. // because it's simpler and it doesn't really matter performance-wise.
a.into_iter() a.into_iter()
} }

View file

@ -1180,7 +1180,7 @@ impl<'help> Arg<'help> {
/// Require another argument if this arg was present on runtime, and its value equals to `val`. /// Require another argument if this arg was present on runtime, and its value equals to `val`.
/// ///
/// This method takes `value, another_arg` pair. At runtime, clap will check /// This method takes `value, another_arg` pair. At runtime, clap will check
/// if this arg (`self`) is is present and its value equals to `val`. /// if this arg (`self`) is present and its value equals to `val`.
/// If it does, `another_arg` will be marked as required. /// If it does, `another_arg` will be marked as required.
/// ///
/// **NOTE:** If using YAML the values should be laid out as follows /// **NOTE:** If using YAML the values should be laid out as follows
@ -1411,7 +1411,7 @@ impl<'help> Arg<'help> {
/// assert!(res.is_ok()); // We didn't use --option=spec, or --extra=val so "cfg" isn't required /// assert!(res.is_ok()); // We didn't use --option=spec, or --extra=val so "cfg" isn't required
/// ``` /// ```
/// ///
/// Setting [`Arg::required_if_eq_any(&[(arg, val)])`] and having any of the `arg`s used with it's /// Setting [`Arg::required_if_eq_any(&[(arg, val)])`] and having any of the `arg`s used with its
/// value of `val` but *not* using this arg is an error. /// value of `val` but *not* using this arg is an error.
/// ///
/// ```rust /// ```rust

View file

@ -36,7 +36,7 @@ use std::ffi::OsString;
/// } /// }
/// ``` /// ```
/// ///
/// The equivilant [`App`] struct + `From` implementation: /// The equivalent [`App`] struct + `From` implementation:
/// ///
/// ```rust /// ```rust
/// # use clap::{App, Arg, ArgMatches}; /// # use clap::{App, Arg, ArgMatches};

View file

@ -52,7 +52,7 @@ impl PartialEq<char> for KeyType {
} }
impl<'help> MKeyMap<'help> { impl<'help> MKeyMap<'help> {
//TODO ::from(x), ::with_capacity(n) etc //TODO ::from(x), ::with_capacity(n) etc.
//? set theory ops? //? set theory ops?
pub(crate) fn contains<K>(&self, key: K) -> bool pub(crate) fn contains<K>(&self, key: K) -> bool

View file

@ -339,7 +339,7 @@ impl<'help, 'app, 'parser, 'writer> Help<'help, 'app, 'parser, 'writer> {
debug!("Help::val: Has switch..."); debug!("Help::val: Has switch...");
if self.use_long { if self.use_long {
// long help prints messages on the next line so it don't need to align text // long help prints messages on the next line so it don't need to align text
debug!("Help::val: printing long help so skip aligment"); debug!("Help::val: printing long help so skip alignment");
} else if arg.has_switch() { } else if arg.has_switch() {
debug!("Yes"); debug!("Yes");
debug!("Help::val: force_next_line...{:?}", self.force_next_line); debug!("Help::val: force_next_line...{:?}", self.force_next_line);

View file

@ -178,7 +178,7 @@ impl<'help, 'app> Parser<'help, 'app> {
assert!( assert!(
ok, ok,
"When using a positional argument with .multiple(true) that is *not the \ "When using a positional argument with .multiple(true) that is *not the \
last* positional argument, the last positional argument (i.e the one \ last* positional argument, the last positional argument (i.e. the one \
with the highest index) *must* have .required(true) or .last(true) set." with the highest index) *must* have .required(true) or .last(true) set."
); );

View file

@ -938,7 +938,7 @@ fn req_delimiter_complex() {
#[test] #[test]
#[should_panic = "When using a positional argument with \ #[should_panic = "When using a positional argument with \
.multiple(true) that is *not the last* positional argument, the last \ .multiple(true) that is *not the last* positional argument, the last \
positional argument (i.e the one with the highest index) *must* have \ positional argument (i.e. the one with the highest index) *must* have \
.required(true) or .last(true) set."] .required(true) or .last(true) set."]
fn low_index_positional_not_required() { fn low_index_positional_not_required() {
let _ = App::new("lip") let _ = App::new("lip")