Issue#2323

[MohitPanchariya]

What type of PR is this?

(REQUIRED)

• feature

What this PR does / why we need it:

(REQUIRED)

• This PR introduces an option to include arbitrary help topics to the help message.
• There exists a way to do this for the Root command right now, through the ExtraInfo field,
  but that requires using a custom template. Its a bit cumbersome to use custom templates from a
  users perspective just to print additional help topics.
• Given the use case to have additional help topics seems generic, this PR changes the default
  help templates to conditionally render additional help topics.

Which issue(s) this PR fixes:

Fixes #2323

(REQUIRED)

Testing

(fill-in or delete this section)

Added unit tests to test additional help topics.

Release Notes

(REQUIRED)

The `AdditionalHelpTopics` field can be used to print arbitrary help topics, in addition to the existing
help topics, without the need for a custom help template.

[dearchap]

@MohitPanchariya I like this PR . Its very clean and backward compatible. However I am more worried about side effects of a special case like this. People will start adding more and more things like this throughout the template. Do you see lots of people using this or is this a one off for convenience ? Strictly speaking users can remap the template to whatever they'd like.

[MohitPanchariya]

@MohitPanchariya I like this PR . Its very clean and backward compatible. However I am more worried about side effects of a special case like this. People will start adding more and more things like this throughout the template. Do you see lots of people using this or is this a one off for convenience ? Strictly speaking users can remap the template to whatever they'd like.

I agree with the sentiment, this PR may end up setting a precedent we may not want.

Given it is trivial to remap the template, I believe we can halt the effort here for now, and revisit later if we see more users asking for a mechanism to print arbitrary key-value pairs, without having to modify the template.

@dearchap Does this sound reasonable?

[dearchap]

@MohitPanchariya Thanks. Yes that sounds reasonable.