docs: improve CLI help text with detailed descriptions and examples#37
Merged
docs: improve CLI help text with detailed descriptions and examples#37
Conversation
Add comprehensive long descriptions and usage examples to the check, run, and root commands for better discoverability of features. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Merged
azu
pushed a commit
that referenced
this pull request
Apr 4, 2026
<!-- Release notes generated using configuration in .github/release.yml at main --> ## What's Changed ### Documentation * docs: Revise installation instructions for clarity by @azu in #36 * docs: improve CLI help text with detailed descriptions and examples by @azu in #37 ### CI * ci: Use release PR body as GitHub Release notes by @azu in #35 * CI: update GitHub Actions dependencies to latest versions by @azu in #34 **Full Changelog**: v1.2.0...v1.2.1 Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
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
1 participant
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
Improve the CLI help text for the
check,run, and root commands by adding detailed long descriptions, status code explanations, and usage examples.Changes
Longdescriptions tocheckCmd,runCmd, androotCmdexplaining supported file types, detection behavior, configuration, and authenticationExamplefields with practical usage patterns (dry-run, write, glob, JSON output, ignore patterns)Breaking Changes
None
Test Plan
dockerfile-pin --help,dockerfile-pin run --help,dockerfile-pin check --helpand verify the output is well-formattedgo buildand existing tests