From cf47635eba59e8d6ec70bedbb3dc6cf97af45233 Mon Sep 17 00:00:00 2001 From: Waldir Pimenta Date: Mon, 8 Dec 2025 00:32:29 +0000 Subject: [PATCH] docs(cli): fix user show command documentation (#1497) As pointed out in [this comment](https://github.com/git-bug/git-bug/issues/530#issuecomment-3558997281), the documentation and CLI help incorrectly suggested that the command to display a user identity was `git-bug user user show USER_ID`, but when the actual command is `git-bug user show USER_ID`. This change fixes the `Use` field in `user_show.go` to use correct `show [USER_ID]` form instead of `user show [USER_ID]`, and updates the documentation and manpages accordingly. --- commands/user/user_show.go | 2 +- doc/man/{git-bug-user-user.1 => git-bug-user-show.1} | 6 +++--- doc/man/git-bug-user.1 | 2 +- doc/md/git-bug_user.md | 2 +- doc/md/{git-bug_user_user.md => git-bug_user_show.md} | 6 +++--- 5 files changed, 9 insertions(+), 9 deletions(-) rename doc/man/{git-bug-user-user.1 => git-bug-user-show.1} (78%) rename doc/md/{git-bug_user_user.md => git-bug_user_show.md} (73%) diff --git a/commands/user/user_show.go b/commands/user/user_show.go index eb302ce8e2c5a3bf27f8634d9dbae83c9a98bcef..ed5b5e227aca6bcc3ff246538ccf8e5666f54145 100644 --- a/commands/user/user_show.go +++ b/commands/user/user_show.go @@ -20,7 +20,7 @@ func newUserShowCommand(env *execenv.Env) *cobra.Command { options := userShowOptions{} cmd := &cobra.Command{ - Use: "user show [USER_ID]", + Use: "show [USER_ID]", Short: "Display a user identity", PreRunE: execenv.LoadBackendEnsureUser(env), RunE: execenv.CloseBackend(env, func(cmd *cobra.Command, args []string) error { diff --git a/doc/man/git-bug-user-user.1 b/doc/man/git-bug-user-show.1 similarity index 78% rename from doc/man/git-bug-user-user.1 rename to doc/man/git-bug-user-show.1 index 503016d5fddece9af78013e3cd8f601bdd4fb43e..d58604b1890f0ab504d381e014831bcc6eb4d7d3 100644 --- a/doc/man/git-bug-user-user.1 +++ b/doc/man/git-bug-user-show.1 @@ -2,11 +2,11 @@ .TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .SH NAME -git-bug-user-user - Display a user identity +git-bug-user-show - Display a user identity .SH SYNOPSIS -\fBgit-bug user user show [USER_ID] [flags]\fP +\fBgit-bug user show [USER_ID] [flags]\fP .SH DESCRIPTION @@ -19,7 +19,7 @@ Display a user identity .PP \fB-h\fP, \fB--help\fP[=false] - help for user + help for show .SH SEE ALSO diff --git a/doc/man/git-bug-user.1 b/doc/man/git-bug-user.1 index 110829eb64d6691082be0ad5c5c83ecdcd6db738..942c827aab996fb84a49335aaf24c09ffe842e54 100644 --- a/doc/man/git-bug-user.1 +++ b/doc/man/git-bug-user.1 @@ -23,4 +23,4 @@ List identities .SH SEE ALSO -\fBgit-bug(1)\fP, \fBgit-bug-user-adopt(1)\fP, \fBgit-bug-user-new(1)\fP, \fBgit-bug-user-user(1)\fP +\fBgit-bug(1)\fP, \fBgit-bug-user-adopt(1)\fP, \fBgit-bug-user-new(1)\fP, \fBgit-bug-user-show(1)\fP diff --git a/doc/md/git-bug_user.md b/doc/md/git-bug_user.md index 8693970508a6366a0be50aea3bcb7b23e33da0a7..4ca299687c5c41a8368227e6dbb618aedff784d9 100644 --- a/doc/md/git-bug_user.md +++ b/doc/md/git-bug_user.md @@ -18,5 +18,5 @@ git-bug user [flags] * [git-bug](git-bug.md) - A bug tracker embedded in Git * [git-bug user adopt](git-bug_user_adopt.md) - Adopt an existing identity as your own * [git-bug user new](git-bug_user_new.md) - Create a new identity -* [git-bug user user](git-bug_user_user.md) - Display a user identity +* [git-bug user show](git-bug_user_show.md) - Display a user identity diff --git a/doc/md/git-bug_user_user.md b/doc/md/git-bug_user_show.md similarity index 73% rename from doc/md/git-bug_user_user.md rename to doc/md/git-bug_user_show.md index b3e6ac9bb6699e4fbd3aa3168c42339962ffc35d..4b5ef534cffb9376f4c271f66006eae7dd5e768f 100644 --- a/doc/md/git-bug_user_user.md +++ b/doc/md/git-bug_user_show.md @@ -1,16 +1,16 @@ -## git-bug user user +## git-bug user show Display a user identity ``` -git-bug user user show [USER_ID] [flags] +git-bug user show [USER_ID] [flags] ``` ### Options ``` -f, --field string Select field to display. Valid values are [email,humanId,id,lastModification,lastModificationLamports,login,metadata,name] - -h, --help help for user + -h, --help help for show ``` ### SEE ALSO