Skip to content

Commit

Permalink
Update help for --allow-list and --deny-list (#729)
Browse files Browse the repository at this point in the history
  • Loading branch information
nwagner84 authored Dec 9, 2023
1 parent 2f656e1 commit a78c902
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 24 deletions.
24 changes: 12 additions & 12 deletions crates/pica-toolkit/src/commands/filter.rs
Original file line number Diff line number Diff line change
Expand Up @@ -64,23 +64,23 @@ pub(crate) struct Filter {
/// Ignore records which are *not* explicitly listed in one of the
/// given allow-lists.
///
/// An allow-list must be an CSV, whereby the first column contains
/// the IDN ([email protected]) or an Apache Arrow file with an `idn` column.
/// If the file extension is `.feather`, `.arrow`, or `.ipc` the
/// file is automatically interpreted as Apache Arrow;
/// otherwise the file is read as CSV.
#[arg(long = "allow-lists", short = 'A')]
/// A allow-list must be an CSV/TSV or Apache Arrow file, whereby
/// a column `idn` exists. If the file extension is `.feather`,
/// `.arrow`, or `.ipc` the file is automatically interpreted
/// as Apache Arrow; file existions `.csv`, `.csv.gz`, `.tsv` or
/// `.tsv.gz` is interpreted as CSV/TSV.
#[arg(long = "allow-list", short = 'A')]
allow_lists: Vec<PathBuf>,

/// Ignore records which are explicitly listed in one of the
/// given deny-lists.
///
/// An allow-list must be an CSV, whereby the first column contains
/// the IDN ([email protected]) or an Apache Arrow file with an `idn` column.
/// If the file extension is `.feather`, `.arrow`, or `.ipc` the
/// file is automatically interpreted as Apache Arrow;
/// otherwise the file is read as CSV.
#[arg(long = "deny-lists", short = 'D')]
/// A deny-list must be an CSV/TSV or Apache Arrow file, whereby
/// a column `idn` exists. If the file extension is `.feather`,
/// `.arrow`, or `.ipc` the file is automatically interpreted
/// as Apache Arrow; file existions `.csv`, `.csv.gz`, `.tsv` or
/// `.tsv.gz` is interpreted as CSV/TSV.
#[arg(long = "deny-list", short = 'D')]
deny_lists: Vec<PathBuf>,

/// Limit the result to first <n> records
Expand Down
24 changes: 12 additions & 12 deletions crates/pica-toolkit/src/commands/select.rs
Original file line number Diff line number Diff line change
Expand Up @@ -114,23 +114,23 @@ pub(crate) struct Select {
/// Ignore records which are *not* explicitly listed in one of the
/// given allow-lists.
///
/// An allow-list must be an CSV, whereby the first column contains
/// the IDN ([email protected]) or an Apache Arrow file with an `idn` column.
/// If the file extension is `.feather`, `.arrow`, or `.ipc` the
/// file is automatically interpreted as Apache Arrow;
/// otherwise the file is read as CSV.
#[arg(long = "allow-lists", short = 'A')]
/// A allow-list must be an CSV/TSV or Apache Arrow file, whereby
/// a column `idn` exists. If the file extension is `.feather`,
/// `.arrow`, or `.ipc` the file is automatically interpreted
/// as Apache Arrow; file existions `.csv`, `.csv.gz`, `.tsv` or
/// `.tsv.gz` is interpreted as CSV/TSV.
#[arg(long = "allow-list", short = 'A')]
allow_lists: Vec<PathBuf>,

/// Ignore records which are explicitly listed in one of the
/// given deny-lists.
///
/// An allow-list must be an CSV, whereby the first column contains
/// the IDN ([email protected]) or an Apache Arrow file with an `idn` column.
/// If the file extension is `.feather`, `.arrow`, or `.ipc` the
/// file is automatically interpreted as Apache Arrow;
/// otherwise the file is read as CSV.
#[arg(long = "deny-lists", short = 'D')]
/// A deny-list must be an CSV/TSV or Apache Arrow file, whereby
/// a column `idn` exists. If the file extension is `.feather`,
/// `.arrow`, or `.ipc` the file is automatically interpreted
/// as Apache Arrow; file existions `.csv`, `.csv.gz`, `.tsv` or
/// `.tsv.gz` is interpreted as CSV/TSV.
#[arg(long = "deny-list", short = 'D')]
deny_lists: Vec<PathBuf>,

/// Show progress bar (requires `-o`/`--output`).
Expand Down

0 comments on commit a78c902

Please sign in to comment.