v2 feature: Use app.Description in templates #1286
Labels
area/v2
relates to / is being considered for v2
status/triage
maintainers still need to look into this
Checklist
What problem does this solve?
I was adding a
.Description
value to my main application, and I was surprised to find the text is not included in the output during man-page and markdown generation. Instead, the templates putApp.UsageText
in a section titledDESCRIPTION
. Was this deliberate? If so, what is the difference betweenApp.UsageText
andApp.Description
? I assumedApp.Description
should be printed in theDESCRIPTION
section, while theApp.UsageText
value is printed in place of the generated Usage Text:Solution description
I believe a diff similar to the following would enable both
UsageText
andDescription
output:Describe alternatives you've considered
I don't like putting my long-form description text in the
UsageText
field.Description
has some nice formatting during console printing, andUsageText
does not.The text was updated successfully, but these errors were encountered: