cobra icon indicating copy to clipboard operation
cobra copied to clipboard

Add aliases to doc markdown

Open divolgin opened this issue 10 months ago • 4 comments

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

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

divolgin avatar Jan 22 '25 19:01 divolgin

CLA assistant check
All committers have signed the CLA.

CLAassistant avatar Jan 22 '25 19:01 CLAassistant

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

marckhouzam avatar Jan 22 '25 23:01 marckhouzam

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".

divolgin avatar Jan 27 '25 21:01 divolgin

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

marckhouzam avatar Feb 02 '25 00:02 marckhouzam