From d7ea38b89a858c5820827c50042dcf4ac39a3c99 Mon Sep 17 00:00:00 2001 From: aarzilli Date: Tue, 16 Oct 2018 09:55:08 +0200 Subject: [PATCH] Documentation: rename "where" parameter of checkpoint to "note" The name "where" may confuse users into thinking that this parameter actually does something where in fact it's just arbitrary text used to identify the checkpoint. Fixes #1373 --- Documentation/cli/README.md | 4 +++- pkg/terminal/command.go | 6 ++++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/Documentation/cli/README.md b/Documentation/cli/README.md index c0378cb8..0f3b707a 100644 --- a/Documentation/cli/README.md +++ b/Documentation/cli/README.md @@ -93,7 +93,9 @@ Current limitations: ## check Creates a checkpoint at the current position. - checkpoint [where] + checkpoint [note] + +The "note" is arbitrary text that can be used to identify the checkpoint, if it is not specified it defaults to the current filename:line position. Aliases: checkpoint diff --git a/pkg/terminal/command.go b/pkg/terminal/command.go index 9a2cf741..0ce7e299 100644 --- a/pkg/terminal/command.go +++ b/pkg/terminal/command.go @@ -356,7 +356,9 @@ If locspec is omitted edit will open the current source file in the editor, othe cmdFn: checkpoint, helpMsg: `Creates a checkpoint at the current position. - checkpoint [where]`, + checkpoint [note] + +The "note" is arbitrary text that can be used to identify the checkpoint, if it is not specified it defaults to the current filename:line position.`, }) c.cmds = append(c.cmds, command{ aliases: []string{"checkpoints"}, @@ -1954,7 +1956,7 @@ func checkpoints(t *Term, ctx callContext, args string) error { } w := new(tabwriter.Writer) w.Init(os.Stdout, 4, 4, 2, ' ', 0) - fmt.Fprintln(w, "ID\tWhen\tWhere") + fmt.Fprintln(w, "ID\tWhen\tNote") for _, cp := range cps { fmt.Fprintf(w, "c%d\t%s\t%s\n", cp.ID, cp.When, cp.Where) } -- GitLab