Small docs tweaks

This commit is contained in:
Yukai Chou 2023-11-23 07:14:38 +08:00
parent ba585149c3
commit afbdb945bc
7 changed files with 9 additions and 8 deletions

View file

@ -43,7 +43,7 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command {
will be forwarded to the %[1]sgh-<extname>%[1]s executable of the extension.
An extension cannot override any of the core gh commands. If an extension name conflicts
with a core gh command you can use %[1]sgh extension exec <extname>%[1]s.
with a core gh command, you can use %[1]sgh extension exec <extname>%[1]s.
See the list of available extensions at <https://github.com/topics/gh-extension>.
`, "`"),
@ -107,7 +107,7 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command {
When not connected to a terminal, the character is rendered as the
word "installed" but otherwise the order and content of the columns
is the same.
are the same.
This command behaves similarly to %[1]sgh search repos%[1]s but does not
support as many search qualifiers. For a finer grained search of

View file

@ -51,7 +51,7 @@ func NewCmdView(f *cmdutil.Factory, runF func(*ViewOptions) error) *cobra.Comman
Long: heredoc.Docf(`
Display the title, body, and other information about an issue.
With %[1]s--web%[1]s, open the issue in a web browser instead.
With %[1]s--web%[1]s flag, open the issue in a web browser instead.
`, "`"),
Args: cobra.ExactArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {

View file

@ -58,7 +58,7 @@ func newCmdCreate(f *cmdutil.Factory, runF func(*createOptions) error) *cobra.Co
Use: "create <name>",
Short: "Create a new label",
Long: heredoc.Docf(`
Create a new label on GitHub, or updates an existing one with %[1]s--force%[1]s.
Create a new label on GitHub, or update an existing one with %[1]s--force%[1]s.
Must specify name for the label. The description and color are optional.
If a color isn't provided, a random one will be chosen.

View file

@ -48,7 +48,7 @@ func NewCmdView(f *cmdutil.Factory, runF func(*ViewOptions) error) *cobra.Comman
Without an argument, the pull request that belongs to the current branch
is displayed.
With %[1]s--web%[1]s, open the pull request in a web browser instead.
With %[1]s--web%[1]s flag, open the pull request in a web browser instead.
`, "`"),
Args: cobra.MaximumNArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {

View file

@ -98,7 +98,7 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co
When using automatically generated release notes, a release title will also be automatically
generated unless a title was explicitly passed. Additional release notes can be prepended to
automatically generated notes by using the notes parameter.
automatically generated notes by using the %[1]s--notes%[1]s flag.
`, "`"),
Example: heredoc.Doc(`
Interactively create a release

View file

@ -50,7 +50,8 @@ func NewCmdRerun(f *cmdutil.Factory, runF func(*RerunOptions) error) *cobra.Comm
However, this %[1]s<number>%[1]s should not be used with the %[1]s--job%[1]s flag and will result in the
API returning %[1]s404 NOT FOUND%[1]s. Instead, you can get the correct job IDs using the following command:
%[1]sgh run view <run-id> --json jobs --jq '.jobs[] | {name, databaseId}'%[1]s.
gh run view <run-id> --json jobs --jq '.jobs[] | {name, databaseId}'
`, "`"),
Args: cobra.MaximumNArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {

View file

@ -57,7 +57,7 @@ func NewCmdRun(f *cmdutil.Factory, runF func(*RunOptions) error) *cobra.Command
Create a %[1]sworkflow_dispatch%[1]s event for a given workflow.
This command will trigger GitHub Actions to run a given workflow file. The given workflow file must
support a %[1]son.workflow_dispatch%[1]s trigger in order to be run in this way.
support an %[1]son.workflow_dispatch%[1]s trigger in order to be run in this way.
If the workflow file supports inputs, they can be specified in a few ways: