PenaDevops/delve
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Documentation: rename "where" parameter of checkpoint to "note"

Browse Source 
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
This commit is contained in:
aarzilli 2018-10-16 09:55:08 +02:00 committed by Derek Parker
parent b59032516e
commit d7ea38b89a
2 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/cli/README.md
View File

@ -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

6
pkg/terminal/command.go
View File

@ -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)
}