Command help and examples still point at deprecated flags
Summary
Several commands advertise flags in their help text and examples that the same commands mark as deprecated. Following the documentation therefore triggers a deprecation warning, or silently uses a flag that no longer does anything.
Found by cross-referencing every MarkDeprecated call against the help text of
the command that declares it.
Environment
- OS: Windows 11 - AMD64
- SHELL: bash
- TERM: Windows Terminal
- GLAB: built from
mainat 411aa39d (also present in v1.109.0)
Steps to reproduce
glab issue list --helpglab incident list --helpglab mr note --help
What is the current bug behavior?
glab issue list and glab incident list both show an example using
--opened. That flag is hidden, deprecated, and already the default, so the
example teaches a flag that adds nothing and warns when used.
glab mr note --help describes --resolve and --unresolve, both deprecated
in favour of the subcommands that replaced them, so the help text steers users
to the path that is being removed.
What is the expected correct behavior?
Help text and examples should only show flags that are current. A flag that is deprecated should not appear in the example a user is most likely to copy.
Possible fixes
Drop --opened from the two list examples, and point the mr note description
at the replacement subcommands.