Skip to content

doc(cli): avoid including code comment in help output#267

Merged
MordechaiHadad merged 1 commit into
MordechaiHadad:masterfrom
tranzystorekk:clean-up-help
Mar 31, 2025
Merged

doc(cli): avoid including code comment in help output#267
MordechaiHadad merged 1 commit into
MordechaiHadad:masterfrom
tranzystorekk:clean-up-help

Conversation

@tranzystorekk

Copy link
Copy Markdown
Contributor

In the 4.0.3 release, the root bob help output currently looks like this:

The `Cli` enum represents the different commands that can be used in the command-line interface

Usage: bob <COMMAND>

Commands:
  use          Switch to the specified version, by default will auto-invoke install command if the version is not installed already
  install      Install the specified version, can also be used to update out-of-date nightly version
  sync         If Config::version_sync_file_location is set, the version in that file will be parsed and installed
  uninstall    Uninstall the specified version [aliases: rm]
  rollback     Rollback to an existing nightly rollback
  erase        Erase any change bob ever made, including neovim installation, neovim version downloads and registry changes
  list         List all installed and used versions [aliases: ls]
  list-remote  [aliases: ls-remote]
  complete     Generate shell completion
  update       Update existing version |nightly|stable|--all|
  help         Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

The top text is taken from a code comment, and looks a bit out of place, this PR makes it an internal comment so that clap doesn't mistake it for app description.

@MordechaiHadad MordechaiHadad merged commit 3f0adc0 into MordechaiHadad:master Mar 31, 2025
@tranzystorekk tranzystorekk deleted the clean-up-help branch March 31, 2025 13:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants