docs(git_status): improve descriptions of options by joshmarkovic · Pull Request #7277 · starship/starship
Conversation
Description
More descriptive documentation
Motivation and Context
Closes #
Screenshots (if appropriate):
How Has This Been Tested?
- I have tested using MacOS
- I have tested using Linux
- I have tested using Windows
Checklist:
- I have updated the documentation accordingly.
- I have updated the tests accordingly.
| | ---------------------- | --------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | ||
| | `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` | | ||
| | `conflicted` | `'='` | This branch has merge conflicts. | | ||
| | `ahead` | `'⇡'` | The format of `ahead` | |
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the more descriptive of this, but these are options for formats not something that will always be shown if the condition is met - I would prefer reflecting that in the descriptions.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the feedback, I made the updates so let me know if this works. Feel free to edit, close, merge the PR as you see fit.
davidkna
changed the title
(docs) Better descriptions in Git Status
docs(git_status): improve descriptions of options
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.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
2 participants