Skip to content

Commit

Permalink
Revise documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
joaander committed Aug 13, 2024
1 parent 020f837 commit ce7eb67
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 5 deletions.
6 changes: 3 additions & 3 deletions doc/src/row/show/status.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Usage:
row show status [OPTIONS] [DIRECTORIES]
```

`row show status` prints a summary of all directories in the workspace.
`row show status` prints a summary of actions in the workflow.
The summary includes the number of directories in each
[status](../../guide/concepts/status.md) and an estimate of the remaining cost in either
CPU-hours or GPU-hours based on the number of submitted, eligible, and waiting jobs and
Expand All @@ -30,9 +30,9 @@ echo "dir1" | row show status -
Set `--action <pattern>` to choose which actions to display by name. By default, **row**
shows the status of all actions. `<pattern>` is a wildcard pattern.

### `-`all`
### `-all`

Show all actions. Even those with 0 directories.
Show all actions. By default, `show status` hides actions with 0 matching directories.

### `--completed`

Expand Down
6 changes: 5 additions & 1 deletion src/cli.rs
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ pub enum ColorMode {
pub enum ShowCommands {
/// Show the current state of the workflow.
///
/// `row show status` prints a summary of all directories in the workspace.
/// `row show status` prints a summary of all actions in the workflow.
/// The summary includes the number of directories in each status and an
/// estimate of the remaining cost in either CPU-hours or GPU-hours based
/// on the number of submitted, eligible, and waiting jobs and the
Expand All @@ -82,6 +82,10 @@ pub enum ShowCommands {
///
/// row show status
///
/// * Show the status of all actions with eligible directories
///
/// row show status --eligible
///
/// * Show the status of a specific action:
///
/// row show status --action=action
Expand Down
2 changes: 1 addition & 1 deletion src/cli/status.rs
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ pub struct Arguments {
#[arg(long, display_order = 0, conflicts_with = "all")]
waiting: bool,

/// Show all actions (even those with 0 directories)
/// Show all actions.
#[arg(long, display_order = 0)]
all: bool,
}
Expand Down

0 comments on commit ce7eb67

Please sign in to comment.