cobra icon indicating copy to clipboard operation
cobra copied to clipboard

Published 20 hours ago • verified publisher icon spf13

Add a COMMANDS section to generated man pages

Open orobardet opened this issue 5 years ago • 8 comments

This PR enhance the man generation with the ability to add a COMMANDS section in generated man page for sub-commands.

When a command has available sub-commands, the COMMANDS man section is generated with the list of sub-commands, with their name, short description, and the name of the dedicated man page.

image

This fixes #680

orobardet avatar Aug 29 '19 08:08 orobardet

CLA assistant check
All committers have signed the CLA.

CLAassistant avatar Aug 29 '19 08:08 CLAassistant

I finished working on this PR, it's ready to be reviewed.

orobardet avatar Aug 30 '19 09:08 orobardet

This PR is being marked as stale due to a long period of inactivity

github-actions[bot] avatar Apr 04 '20 00:04 github-actions[bot]

Is there anything to do or change to help on this PR?

orobardet avatar Apr 04 '20 09:04 orobardet

cc @jharshman

olivierlemasle avatar Apr 06 '20 21:04 olivierlemasle

Would need fixed up to use a StringWriter instead of the bytes.Buffer. Untagged the issue as stale and mentioned it with maintainers to see if others want to see this merged.

johnSchnake avatar Mar 28 '22 13:03 johnSchnake

Hi @johnSchnake Thanks for you curation work.

I just pushed an update rebased on the latest master, and using StringWriter. Which maintainer do I need to mention to have a look on this PR?

orobardet avatar Apr 20 '22 12:04 orobardet

@orobardet see https://github.com/spf13/cobra/blob/master/MAINTAINERS#L2-L5

umarcor avatar Apr 21 '22 07:04 umarcor