actions/typos
1
0
Fork 0
mirror of https://github.com/crate-ci/typos.git synced 2025-01-11 01:01:36 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs(args): Clarify command line arguments

Browse source
This commit is contained in:
Ed Page 2021-01-04 13:37:56 -06:00
parent 02e8792e94
commit 70163fae61
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
src/args.rs
View file

@ -43,7 +43,7 @@ impl Default for Format {
)] )]
pub(crate) struct Args { pub(crate) struct Args {
#[structopt(parse(from_os_str), default_value = ".")] #[structopt(parse(from_os_str), default_value = ".")]
/// Paths to check /// Paths to check with `-` for stdin
pub(crate) path: Vec<std::path::PathBuf>, pub(crate) path: Vec<std::path::PathBuf>,
#[structopt(short = "c", long = "config")] #[structopt(short = "c", long = "config")]
@ -59,19 +59,19 @@ pub(crate) struct Args {
pub(crate) diff: bool, pub(crate) diff: bool,
#[structopt(long, short = "w")] #[structopt(long, short = "w")]
/// Write corrections out /// Write fixes out
pub(crate) write_changes: bool, pub(crate) write_changes: bool,
#[structopt(long)] #[structopt(long)]
/// Print each file that would be spellchecked. /// Debug: Print each file that would be spellchecked.
pub(crate) files: bool, pub(crate) files: bool,
#[structopt(long)] #[structopt(long)]
/// Print each identifier that would be spellchecked. /// Debug: Print each identifier that would be spellchecked.
pub(crate) identifiers: bool, pub(crate) identifiers: bool,
#[structopt(long)] #[structopt(long)]
/// Print each word that would be spellchecked. /// Debug: Print each word that would be spellchecked.
pub(crate) words: bool, pub(crate) words: bool,
#[structopt(flatten)] #[structopt(flatten)]