Skip to content

Worktrunk is a CLI for Git worktree management, designed for parallel AI agent workflows

docs(cli): drop redundant --format value parenthetical where clap lists them (#3112)

Maximilian Roos68dae3a2fc7c
diff --git a/docs/content/config.md b/docs/content/config.md
index 4fa158892..6adb939e4 100644
--- a/docs/content/config.md
+++ b/docs/content/config.md
@@ -629,7 +629,7 @@ Usage: <b><span class=c>wt config show</span></b> <span class=c>[OPTIONS]</span>
<b><span class=g>Output:</span></b>
<b><span class=c>--format</span></b><span class=c> &lt;FORMAT&gt;</span>
- Output format (text, json)
+ Output format
[default: text]
[possible values: text, json]
diff --git a/docs/content/step.md b/docs/content/step.md
index 3fc26b32b..23abdd84a 100644
--- a/docs/content/step.md
+++ b/docs/content/step.md
@@ -631,7 +631,7 @@ Usage: <b><span class=c>wt step for-each</span></b> <span class=c>[OPTIONS]</spa
<b><span class=g>Options:</span></b>
<b><span class=c>--format</span></b><span class=c> &lt;FORMAT&gt;</span>
- Output format (text, json)
+ Output format
[default: text]
[possible values: text, json]
@@ -779,7 +779,7 @@ Usage: <b><span class=c>wt step prune</span></b> <span class=c>[OPTIONS]</span>
Run removal in foreground (block until complete)
<b><span class=c>--format</span></b><span class=c> &lt;FORMAT&gt;</span>
- Output format (text, json)
+ Output format
[default: text]
[possible values: text, json]
diff --git a/skills/worktrunk/reference/config.md b/skills/worktrunk/reference/config.md
index 947b54b15..c194c2b10 100644
--- a/skills/worktrunk/reference/config.md
+++ b/skills/worktrunk/reference/config.md
@@ -630,7 +630,7 @@ Options:
Output:
--format <FORMAT>
- Output format (text, json)
+ Output format
[default: text]
[possible values: text, json]
diff --git a/skills/worktrunk/reference/step.md b/skills/worktrunk/reference/step.md
index fcc6b4517..8a4e36fcf 100644
--- a/skills/worktrunk/reference/step.md
+++ b/skills/worktrunk/reference/step.md
@@ -658,7 +658,7 @@ Arguments:
Options:
--format <FORMAT>
- Output format (text, json)
+ Output format
[default: text]
[possible values: text, json]
@@ -816,7 +816,7 @@ Options:
Run removal in foreground (block until complete)
--format <FORMAT>
- Output format (text, json)
+ Output format
[default: text]
[possible values: text, json]
diff --git a/src/cli/config.rs b/src/cli/config.rs
index edf247eb4..cf0667fa9 100644
--- a/src/cli/config.rs
+++ b/src/cli/config.rs
@@ -489,7 +489,7 @@ This tests:
#[arg(long)]
full: bool,
- /// Output format (text, json)
+ /// Output format
#[arg(long, default_value = "text", help_heading = "Output")]
format: SwitchFormat,
},
@@ -1447,7 +1447,7 @@ $ wt config state vars list --branch=feature
#[arg(long, add = crate::completion::branch_value_completer())]
branch: Option<String>,
- /// Output format (text, json)
+ /// Output format
#[arg(long, default_value = "text", help_heading = "Output")]
format: SwitchFormat,
},
diff --git a/src/cli/list.rs b/src/cli/list.rs
index f46d7b201..54ed0cb3d 100644
--- a/src/cli/list.rs
+++ b/src/cli/list.rs
@@ -25,7 +25,7 @@ pub enum ListSubcommand {
The pace segment appears only when usage is likely to hit a rate limit before its window resets, and shows the higher-risk window: `2.9×(Tue–Tue 5pm)` reads as 2.9× the pace that would exactly fill that window. Above 90% used it shows usage instead of pace — `93%(Tue–Tue 5pm)` — near the cap, how much is left matters more than how fast it's going. "Likely" is a Bayesian forecast; early-window bursts don't trigger it. With `-vv`, each window's inputs and projection are logged to `.git/wt/logs/trace.log`.
"#)]
Statusline {
- /// Output format (table, json, claude-code)
+ /// Output format
#[arg(long, value_enum, default_value = "table")]
format: OutputFormat,
diff --git a/src/cli/step.rs b/src/cli/step.rs
index c1426b063..45ee1c570 100644
--- a/src/cli/step.rs
+++ b/src/cli/step.rs
@@ -504,7 +504,7 @@ Note: This command is experimental and may change in future versions.
"#
)]
ForEach {
- /// Output format (text, json)
+ /// Output format
#[arg(long, default_value = "text")]
format: crate::cli::SwitchFormat,
@@ -611,7 +611,7 @@ $ wt step prune
#[arg(long)]
foreground: bool,
- /// Output format (text, json)
+ /// Output format
#[arg(long, default_value = "text")]
format: crate::cli::SwitchFormat,
},
diff --git a/tests/snapshots/integration__integration_tests__help__help_config_show.snap b/tests/snapshots/integration__integration_tests__help__help_config_show.snap
index 62980a649..2326d061a 100644
--- a/tests/snapshots/integration__integration_tests__help__help_config_show.snap
+++ b/tests/snapshots/integration__integration_tests__help__help_config_show.snap
@@ -46,7 +46,7 @@ Usage: wt config show [OPTIONS]
Output:
--format <FORMAT>
- Output format (text, json)
+ Output format
[default: text]
[possible values: text, json]