mirror of
https://github.com/starship/starship
synced 2024-09-06 00:09:26 +00:00
docs(config): Replace misleading $all reference (#4519)
In the config `$all` has special meaning, as it is and contains the default value for `format`. Using `$all` in the example for conditional format strings with multiple variables is thus potentially misleading and confusing. Using a neutral variable `$combined` has no conflict with other meanings and is thus preferable.
This commit is contained in:
parent
14ee81b9c3
commit
fcd217c197
|
@ -124,7 +124,7 @@ For example:
|
|||
|
||||
- `(@$region)` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region.
|
||||
- `(some text)` will always show nothing since there are no variables wrapped in the braces.
|
||||
- When `$all` is a shortcut for `\[$a$b\]`, `($all)` will show nothing only if `$a` and `$b` are both `None`.
|
||||
- When `$combined` is a shortcut for `\[$a$b\]`, `($combined)` will show nothing only if `$a` and `$b` are both `None`.
|
||||
This works the same as `(\[$a$b\] )`.
|
||||
|
||||
#### Special characters
|
||||
|
|
Loading…
Reference in a new issue