Skip to content

Commit

Permalink
docs(args): Clarify command line arguments
Browse files Browse the repository at this point in the history
  • Loading branch information
Ed Page committed Jan 4, 2021
1 parent 02e8792 commit 70163fa
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions src/args.rs
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ impl Default for Format {
)]
pub(crate) struct Args {
#[structopt(parse(from_os_str), default_value = ".")]
/// Paths to check
/// Paths to check with `-` for stdin
pub(crate) path: Vec<std::path::PathBuf>,

#[structopt(short = "c", long = "config")]
Expand All @@ -59,19 +59,19 @@ pub(crate) struct Args {
pub(crate) diff: bool,

#[structopt(long, short = "w")]
/// Write corrections out
/// Write fixes out
pub(crate) write_changes: bool,

#[structopt(long)]
/// Print each file that would be spellchecked.
/// Debug: Print each file that would be spellchecked.
pub(crate) files: bool,

#[structopt(long)]
/// Print each identifier that would be spellchecked.
/// Debug: Print each identifier that would be spellchecked.
pub(crate) identifiers: bool,

#[structopt(long)]
/// Print each word that would be spellchecked.
/// Debug: Print each word that would be spellchecked.
pub(crate) words: bool,

#[structopt(flatten)]
Expand Down

0 comments on commit 70163fa

Please sign in to comment.