Skip to content

Print command aliases in docs, not as a section #2271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
commit111 wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Print command aliases in docs, not as a section #2271

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d4cc366
print aliases
commit111 Apr 25, 2025
763bf02
update to not use seperate fn
commit111 Apr 25, 2025
b228800
add parent path
commit111 Apr 25, 2025
b500586
print on one line, and remove parent path
commit111 Apr 25, 2025
659f06e
Update doc/md_docs.go
commit111 Apr 25, 2025
d3dbb42
Update doc/md_docs.go
commit111 Apr 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions doc/md_docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,14 @@ func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string)
buf.WriteString(fmt.Sprintf("```\n%s\n```\n\n", cmd.UseLine()))
}

if len(cmd.Aliases) > 0 {
buf.WriteString("### Aliases\n\n")
for _, alias := range cmd.Aliases {
buf.WriteString(fmt.Sprintf("* `%s`\n", alias))
}
buf.WriteString("\n")
}
Copy link
Contributor

@ccoVeille ccoVeille Apr 25, 2025

Choose a reason for hiding this comment

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

🎨 this is a pure stylistic feedbacks.

It's open for debate.

Maybe the rendering could be different when there is only one alias.

Because this might seem empty as a section

### Aliases

* foobar

So, here maybe another rendering could be considered.

When multiple aliases are available

Aliases: foobar, fooquz

And when there is only one

Aliases: foobar

Please note, I didn't use a section on purpose


if len(cmd.Example) > 0 {
buf.WriteString("### Examples\n\n")
buf.WriteString(fmt.Sprintf("```\n%s\n```\n\n", cmd.Example))
Expand Down