Skip to content

docs(cli): fix user show command documentation - #1497

Merged
sudoforge merged 1 commit into
git-bug:trunkfrom
waldyrious:fix/user-show-command-docs
Dec 8, 2025
Merged

sudoforge merged 1 commit into
git-bug:trunkfrom
waldyrious:fix/user-show-command-docs

Conversation

@waldyrious

@waldyrious waldyrious commented Nov 20, 2025 •

Copy link
Copy Markdown
Contributor

As pointed out in this comment, the documentation and CLI help incorrectly suggested that the command to display a user identity was git-bug user user show USER_ID, but 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.

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.

@sudoforge sudoforge left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good catch, and thanks for this contribution!

+1 for the great commit subject and message, and for regenerating the documentation :)

@sudoforge
sudoforge added this pull request to the merge queue Dec 8, 2025
Merged via the queue into git-bug:trunk with commit cf47635 Dec 8, 2025
8 checks passed
@waldyrious
waldyrious deleted the fix/user-show-command-docs branch December 8, 2025 02:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants