summaryrefslogtreecommitdiffstats
path: root/docs/config
diff options
context:
space:
mode:
authorIzhak Jakov <izak723@gmail.com>2022-03-16 16:05:13 -0400
committerGitHub <noreply@github.com>2022-03-16 16:05:13 -0400
commit86953272a7f1471e9a3422a7543d97b953406df6 (patch)
treee02d7647837a161e350e3c9aeb66191242994753 /docs/config
parent52fa4bbab4393589aebbeded4351886e657a6275 (diff)
fix(status): Make status module work even when the status is 0 (#3750)
Co-authored-by: Izhak Jakov <jizhak@ca.ibm.com>
Diffstat (limited to 'docs/config')
-rw-r--r--docs/config/README.md9
1 files changed, 5 insertions, 4 deletions
diff --git a/docs/config/README.md b/docs/config/README.md
index 7a5617dea..7a1607741 100644
--- a/docs/config/README.md
+++ b/docs/config/README.md
@@ -3083,7 +3083,7 @@ format = '[📦 \[$env\]]($style) '
## Status
The `status` module displays the exit code of the previous command.
-The module will be shown only if the exit code is not `0`.
+If $success_symbol is empty (default), the module will be shown only if the exit code is not `0`.
The status code will cast to a signed 32-bit integer.
::: tip
@@ -3103,7 +3103,7 @@ This module is not supported on nu shell.
| ----------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------- |
| `format` | `"[$symbol$status]($style) "` | The format of the module |
| `symbol` | `"✖"` | The symbol displayed on program error |
-| `success_symbol` | `"✔️"` | The symbol displayed on program success |
+| `success_symbol` | `""` | The symbol displayed on program success |
| `not_executable_symbol` | `"🚫"` | The symbol displayed when file isn't executable |
| `not_found_symbol` | `"🔍"` | The symbol displayed when the command can't be found |
| `sigint_symbol` | `"🧱"` | The symbol displayed on SIGINT (Ctrl + c) |
@@ -3140,8 +3140,9 @@ This module is not supported on nu shell.
[status]
style = "bg:blue"
-symbol = "🔴"
-format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) '
+symbol = "🔴 "
+success_symbol = "🟢 SUCCESS"
+format = '[\[$symbol$common_meaning$signal_name$maybe_int\]]($style) '
map_symbol = true
disabled = false
```