cobra icon indicating copy to clipboard operation
cobra copied to clipboard

markdown documents and help command should show information about deprecated flags

Open tharun208 opened this issue 2 years ago • 1 comments

Currently, the generated markdown and the help command do not give any information about deprecated flags in the output and in the markdown. So, this might cause the user's not to know about the flags that are deprecated and might face some issues in the long run.

tharun208 avatar Jul 25 '22 16:07 tharun208

The question to answer before this can be implemented is where to add the configuration.

Since the deprecation of different flags/options occurs at different times, I think it makes sense to add deprecated values by default and, if you want them hidden from docs then you have to mark them as hidden as well?

You could also make a global option like 'showDeprecatedOptions' but some may have just gotten deprecated and others about to be removed from support.

Thoughts?

johnSchnake avatar Aug 15 '22 18:08 johnSchnake

The Cobra project currently lacks enough contributors to adequately respond to all issues. This bot triages issues and PRs according to the following rules:

  • After 60d of inactivity, lifecycle/stale is applied. - After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied and the issue is closed. You can:
  • Make a comment to remove the stale label and show your support. The 60 days reset. - If an issue has lifecycle/rotten and is closed, comment and ask maintainers if they'd be interseted in reopening

github-actions[bot] avatar Oct 15 '22 00:10 github-actions[bot]