Skip to content
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

Jump to bottom

Add aliases to doc markdown #2223

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add aliases to doc markdown #2223

wants to merge 1 commit into from
+5 −0

Conversation

divolgin
Copy link

@divolgin divolgin commented Jan 22, 2025 •
edited
Loading

Adds aliases to generated markdown docs, similar to how it's handled in the default help template:

Aliases:
  {{.NameAndAliases}}{{end}}{{if .HasExample}}

@CLAassistant
Copy link

CLAassistant commented Jan 22, 2025 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added the area/docs-generation Generation of docs via Cobra label Jan 22, 2025
@divolgin divolgin marked this pull request as ready for review January 22, 2025 19:40
@divolgin divolgin mentioned this pull request Jan 22, 2025
Merged
@marckhouzam
Copy link
Collaborator

So this would change the existing behavior? I wonder if this is a backwards compatibility issue?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
area/docs-generation Generation of docs via Cobra
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@divolgin @CLAassistant @marckhouzam