Skip to content

Conversation

divolgin
Copy link

@divolgin divolgin commented Jan 22, 2025

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

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
@marckhouzam
Copy link
Collaborator

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

@divolgin
Copy link
Author

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

It changes generated doc format by adding the list of aliases. I guess you could call it "changes to existing behavior".

@marckhouzam
Copy link
Collaborator

I think this would be safe to add but I’m not sure.
@jpmcb do you think this could break existing programs?

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

Successfully merging this pull request may close these issues.

3 participants