From 2661c1b0368a59b086c0598e8242b69730671d1a Mon Sep 17 00:00:00 2001 From: Khionu Sybiern Date: Thu, 7 Mar 2024 12:01:17 -0800 Subject: [PATCH] cli: update help message for `jj edit` This change updates the language of `jj edit`'s help message to be more clear as to the nature of the command. It also adds a recommendation for a more idiomatic/safer workflow. --- cli/src/commands/edit.rs | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/cli/src/commands/edit.rs b/cli/src/commands/edit.rs index 9a4aac7c650..5194392f2f4 100644 --- a/cli/src/commands/edit.rs +++ b/cli/src/commands/edit.rs @@ -21,10 +21,12 @@ use crate::cli_util::{CommandHelper, RevisionArg}; use crate::command_error::CommandError; use crate::ui::Ui; -/// Edit a commit in the working copy +/// Loads the contents of the specified revision and sets it as the active changeset. /// -/// Puts the contents of a commit in the working copy for editing. Any changes -/// you make in the working copy will update (amend) the commit. +/// Note, it is recommended to instead to use `jj new` and `jj amend`. Creating a new +/// changeset enables being more intentional with respect to the existing revision. +/// +/// For more information, see https://github.com/martinvonz/jj/blob/main/docs/FAQ.md#how-do-i-resume-working-on-an-existing-change #[derive(clap::Args, Clone, Debug)] pub(crate) struct EditArgs { /// The commit to edit