cobra icon indicating copy to clipboard operation
cobra copied to clipboard

Published 20 hours ago • verified publisher icon spf13

Document SilenceUsage, Hidden

Open garthk opened this issue 9 years ago • 5 comments

Neither SilenceUsage nor Hidden are documented. SilenceUsage deserves a mention under Alternative Error Handling because otherwise you'll get usage output on all errors. Hidden deserves mention under Markdown Docs and Man Docs as it enables a convenient hidden generate-docs command.

garthk avatar Jan 16 '16 05:01 garthk

This needs a follow-up to check if still relevant.

jharshman avatar Mar 31 '20 22:03 jharshman

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

github-actions[bot] avatar May 31 '20 00:05 github-actions[bot]

It would help to have examples and usage documented for Hidden.

valaparthvi avatar Apr 12 '21 12:04 valaparthvi

The SilenceUsage was merged but later removed to shorten the readme; this was prior to the main readme being separated from the user guide. (see https://github.com/spf13/cobra/commit/e8e7fe03552f0645ccf4c507f38bcf88b1c2b2d6#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L830)

I think this issue can remain open and we'd review a PR for it.

Closing #1376 as duplicate then.

johnSchnake avatar Feb 16 '22 15:02 johnSchnake

@garthk this still worth looking into. I would be open totally asking a crack at it.

tlarnold10 avatar Jun 27 '24 03:06 tlarnold10