From 0abf4b937e6bab416321b7460fd642bec40b2d57 Mon Sep 17 00:00:00 2001 From: Martin Weissbach Date: Sun, 18 Dec 2022 03:51:38 +0100 Subject: [PATCH] docs(config): clarify git-commit tag variable (#4729) 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 --- docs/config/README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/config/README.md b/docs/config/README.md index 4d1a7161..5cd20bad 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -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