docs: improve readability of usage section in help#85
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR improves the readability of the usage section in the help text by restructuring parameter documentation from inline descriptions to a cleaner glossary-style format. The changes enhance the command reference documentation by making it easier to scan and understand the available parameters.
Changes:
- Restructured the usage section to separate usage patterns from parameter definitions
- Reformatted parameter descriptions using a glossary-style layout with left-aligned parameter names
- Simplified "personal access token" to "access token" in the command reference for brevity
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/gimmegit/_help.py | Updated help text with improved usage section formatting and glossary-style parameter definitions |
| README.md | Applied identical formatting improvements to the command reference section to maintain consistency |
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.
No description provided.