Document auth switch behaviour for two or more accounts

This commit is contained in:
William Martin 2024-03-18 17:24:38 +01:00
parent 96f1074c63
commit 0f5d2aed0a

View file

@ -38,6 +38,10 @@ func NewCmdSwitch(f *cmdutil.Factory, runF func(*SwitchOptions) error) *cobra.Co
This command changes the authentication configuration that will
be used when running commands targeting the specified GitHub host.
If the specified host has two accounts, the active account will be switched
automatically. If there are more than two accounts, disambiguation will be
required either through the %[1]s--user%[1]s flag or an interactive prompt.
For a list of authenticated accounts you can run %[1]sgh auth status%[1]s.
`, "`"),
Example: heredoc.Doc(`