Llewellyn/starship
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/starship.git synced 2024-06-07 02:50:47 +00:00
Code Issues Releases Activity

docs(config): clarify git-commit tag variable (#4729)

Browse Source 
The `git_commit` module uses a `tag` variable in its format string,
which is not explained in the Variables section of this module.

Missing clarification of this `tag` variable is added to the
documentation of the `git_commit` module.

Fixes starship/4640
This commit is contained in:
Martin Weissbach 2022-12-18 03:51:38 +01:00 committed by GitHub
parent aa6c2dd588
commit 0abf4b937e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/config/README.md
View File

@ -1641,10 +1641,11 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
### Variables
| Variable | Example | Description |
| -------- | --------- | ----------------------------------- |
| hash | `b703eb3` | The current git commit hash |
| style\* | | Mirrors the value of option `style` |
| Variable | Example | Description |
| -------- | --------- | -------------------------------------------- |
| hash | `b703eb3` | The current git commit hash |
| tag | `v1.0.0` | The tag name if showing tag info is enabled. |
| style\* | | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string