Re: [PATCH 1/9] git-stash.txt: be explicit about subcommand options
From: Eric Sunshine <hidden>
Date: 2021-02-02 17:41:25
On Tue, Feb 2, 2021 at 4:36 AM Denton Liu [off-list ref] wrote:
quoted hunk ↗ jump to hunk
Currently, the options for the `list` and `show` subcommands are just listed as `<options>`. This seems to imply, from a cursory glance at the summary, that they take the stash options listed below. However, reading more carefully, we see that they take log options and diff options respectively. Make it more obvious that they take log and diff options by explicitly stating this in the subcommand summary. Signed-off-by: Denton Liu <redacted> ---diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt@@ -67,7 +67,7 @@ save [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q -list [<options>]:: +list [<log options>]:: -show [<options>] [<stash>]:: +show [<diff options>] [<stash>]::
I might suggest that it is more common to hyphenate these words than
to separate them with spaces:
list [<log-options>]::
show [<diff-options>] [<stash>]::