Skip to content

Commit

Permalink
improve help
Browse files Browse the repository at this point in the history
  • Loading branch information
jhspetersson committed Sep 22, 2024
1 parent f85d502 commit d4af775
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@ Prints task property.
Sets task property:

git task set 1 description "I figured it out all wrong. Fizz Buzz has to be rewritten in Rust!"
git task set 1..10 author me

### unset

Expand Down
16 changes: 8 additions & 8 deletions src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ enum Command {
},
/// Update task status
Status {
/// one or more task IDs
/// one or more task IDs (space separated or a range like 1..10)
#[clap(required = true)]
ids: Vec<String>,
/// status (by default: o - OPEN, i - IN_PROGRESS, c - CLOSED)
Expand All @@ -104,7 +104,7 @@ enum Command {
},
/// Set a property
Set {
/// space separated task IDs
/// one or more task IDs (space separated or a range like 1..10)
ids: Vec<String>,
/// property name
prop_name: String,
Expand All @@ -122,7 +122,7 @@ enum Command {
},
/// Delete a property
Unset {
/// space separated task IDs
/// one or more task IDs (space separated or a range like 1..10)
ids: Vec<String>,
/// property name
prop_name: String,
Expand All @@ -141,15 +141,15 @@ enum Command {
},
/// Import tasks from a source
Import {
/// space separated task IDs
/// one or more task IDs (space separated or a range like 1..10)
ids: Option<Vec<String>>,
/// Input format (only JSON is currently supported)
#[arg(short, long)]
format: Option<String>,
},
/// Export tasks
Export {
/// space separated task IDs
/// one or more task IDs (space separated or a range like 1..10)
ids: Option<Vec<String>>,
/// Filter by status (by default: o - OPEN, i - IN_PROGRESS, c - CLOSED)
#[arg(short, long, value_delimiter = ',')]
Expand All @@ -166,7 +166,7 @@ enum Command {
},
/// Pull tasks from a remote source (e.g., GitHub)
Pull {
/// space separated task IDs
/// one or more task IDs (space separated or a range like 1..10)
ids: Option<Vec<String>>,
/// Limit the count of imported tasks
#[arg(short, long, conflicts_with = "ids")]
Expand All @@ -183,7 +183,7 @@ enum Command {
},
/// Push task status to the remote source (e.g., GitHub)
Push {
/// space separated task IDs
/// one or more task IDs (space separated or a range like 1..10)
ids: Vec<String>,
/// Use this remote if there are several of them
#[arg(short, long)]
Expand All @@ -204,7 +204,7 @@ enum Command {
/// Delete one or several tasks at once
#[clap(visible_aliases(["del", "remove", "rem"]))]
Delete {
/// space separated task IDs
/// one or more task IDs (space separated or a range like 1..10)
#[clap(required = true)]
ids: Option<Vec<String>>,
/// Delete by status (by default: o - OPEN, i - IN_PROGRESS, c - CLOSED)
Expand Down

0 comments on commit d4af775

Please sign in to comment.