fix: show descriptions for the assert and run subcommands in --help#65
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes the bioassert --help output by adding missing Rust doc comments to the assert and run clap subcommand enum variants, so they render non-blank descriptions like suggest already does.
Changes:
- Added a help/description doc comment for the
assertsubcommand. - Added a help/description doc comment for the
runsubcommand.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
0cb310c to
32abd8a
Compare
32abd8a to
189a91a
Compare
The assert and run subcommands rendered with blank descriptions in `bioassert --help` because their Commands enum variants had no doc comment, unlike suggest. Add `///` doc comments matching the README wording so all subcommands describe themselves. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
Adding the doc comment made rustfmt collapse `Assert { assertion: String }`
onto one line. Apply it so `cargo fmt --check` passes.
Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
189a91a to
5d6c848
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The
assertandrunsubcommands rendered with blank descriptions inbioassert --helpbecause theirCommandsenum variants had no///doc comment, unlikesuggest. This adds doc comments matching the existing README wording so every subcommand describes itself.Before:
After:
Notes
cliis a private module in the binary, so there is no library API change.tests/cli_flags_test.rsasserts only onUsage:substrings, so the suite stays green; fullcargo testpasses locally.🤖 Generated with Claude Code