From 3d1ce5b6fd75f237f6f66c57dbbea280767a2dd9 Mon Sep 17 00:00:00 2001 From: jyn Date: Sun, 4 Feb 2024 10:43:55 -0500 Subject: [PATCH] document that `jj util completion` defaults to bash it's somewhat confusing to me that the `--bash` flag exists at all, since it does nothing - maybe it makes sense to give a hard error? or just remove the flag? but in any case, it seems good to document the existing behavior. --- cli/src/commands/util.rs | 2 +- cli/tests/cli-reference@.md.snap | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/cli/src/commands/util.rs b/cli/src/commands/util.rs index f1c790a5b..aefae92c1 100644 --- a/cli/src/commands/util.rs +++ b/cli/src/commands/util.rs @@ -36,7 +36,7 @@ pub(crate) enum UtilCommand { /// Print a command-line-completion script #[derive(clap::Args, Clone, Debug)] pub(crate) struct UtilCompletionArgs { - /// Print a completion script for Bash + /// Print a completion script for Bash (default) /// /// Apply it by running this: /// diff --git a/cli/tests/cli-reference@.md.snap b/cli/tests/cli-reference@.md.snap index b042c4a1b..09efbe8a6 100644 --- a/cli/tests/cli-reference@.md.snap +++ b/cli/tests/cli-reference@.md.snap @@ -1712,7 +1712,7 @@ Print a command-line-completion script ###### **Options:** -* `--bash` — Print a completion script for Bash +* `--bash` — Print a completion script for Bash (default) Possible values: `true`, `false`