-
Notifications
You must be signed in to change notification settings - Fork 0
docs: add comprehensive help output #69
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds comprehensive help documentation to gimmegit, expanding the help output from a basic usage summary to a detailed guide covering all features and options.
Key changes:
- Expanded help text from ~20 lines to ~92 lines with detailed sections for usage, arguments, options, and examples
- Updated error message wording for clarity ("contains" instead of "has")
- Corrected capitalization of "Git" in documentation
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/gimmegit/_help.py | Complete rewrite of help text with comprehensive documentation including usage patterns, directory structure, branch mapping, options, and examples |
| src/gimmegit/_cli.py | Updated error message to use "contains" instead of "has" for clarity |
| tests/functional/test_clone.py | Updated test expectation to match the new error message wording |
| README.md | Standardized capitalization of "Git" and improved formatting of multi-line command examples |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.
|
@copilot let's add a step to the "checks" CI that checks that the help output in README.md matches the output of
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.
This PR expands the output of
gimmegit -hwith an essentially complete summary of how thegimmegitcommand works. I've duplicated the help output in the README and added an automatic check that the README is up-to-date.