From 2db88b47b9f640e2e3187029d4ebeab2796e9537 Mon Sep 17 00:00:00 2001 From: Jan Klass Date: Sat, 22 Oct 2022 20:28:29 +0200 Subject: [PATCH] docs(config): Add missing default values (#4520) * docs(config): Add missing empty table default values as empty inline tables * docs(config): Add missing empty string default values in shell and vcsh --- docs/config/README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/config/README.md b/docs/config/README.md index e4094b61..0c2d863e 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -337,8 +337,8 @@ falls back to the `x_security_token_expires` key. | ------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | The format for the module. | | `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | -| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | -| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | +| `region_aliases` | `{}` | Table of region aliases to display in addition to the AWS name. | +| `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. | | `style` | `"bold yellow"` | The style for the module. | | `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | | `disabled` | `false` | Disables the `AWS` module. | @@ -1464,8 +1464,8 @@ This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gc | ----------------- | -------------------------------------------------------- | ---------------------------------------------------------------- | | `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | The format for the module. | | `symbol` | `"☁️ "` | The symbol used before displaying the current GCP profile. | -| `region_aliases` | | Table of region aliases to display in addition to the GCP name. | -| `project_aliases` | | Table of project aliases to display in addition to the GCP name. | +| `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. | +| `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. | | `style` | `"bold blue"` | The style for the module. | | `disabled` | `false` | Disables the `gcloud` module. | @@ -2174,8 +2174,8 @@ case the module will only be active in directories that match those conditions. | `symbol` | `"☸ "` | A format string representing the symbol displayed before the Cluster. | | `format` | `'[$symbol$context( \($namespace\))]($style) in '` | The format for the module. | | `style` | `"cyan bold"` | The style for the module. | -| `context_aliases` | | Table of context aliases to display. | -| `user_aliases` | | Table of user aliases to display. | +| `context_aliases` | `{}` | Table of context aliases to display. | +| `user_aliases` | `{}` | Table of user aliases to display. | | `detect_extensions` | `[]` | Which extensions should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this modules. | @@ -3330,7 +3330,7 @@ To enable it, set `disabled` to `false` in your configuration file. | `xonsh_indicator` | `"xsh"` | A format string used to represent xonsh. | | `cmd_indicator` | `"cmd"` | A format string used to represent cmd. | | `nu_indicator` | `"nu"` | A format string used to represent nu. | -| `unknown_indicator` | | The default value to be displayed when the shell is unknown. | +| `unknown_indicator` | `""` | The default value to be displayed when the shell is unknown. | | `format` | `"[$indicator]($style) "` | The format for the module. | | `style` | `"white bold"` | The style for the module. | | `disabled` | `true` | Disables the `shell` module. | @@ -3857,7 +3857,7 @@ The module will be shown only if a repository is currently in use. | Option | Default | Description | | ---------- | -------------------------------- | ------------------------------------------------------ | -| `symbol` | | The symbol used before displaying the repository name. | +| `symbol` | `""` | The symbol used before displaying the repository name. | | `style` | `"bold yellow"` | The style for the module. | | `format` | `"vcsh [$symbol$repo]($style) "` | The format for the module. | | `disabled` | `false` | Disables the `vcsh` module. |