From 9251778a9c2c57ff67fc89bc7cb82f3eff3ef11f Mon Sep 17 00:00:00 2001 From: Thomas O'Donnell Date: Thu, 14 May 2020 00:19:21 +0200 Subject: [PATCH] docs: correct the configuration docs (#1195) --- docs/config/README.md | 89 ++++++++++++++++++++++--------------------- 1 file changed, 45 insertions(+), 44 deletions(-) diff --git a/docs/config/README.md b/docs/config/README.md index 42a97cca2..664ec229a 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -479,10 +479,11 @@ The module will be shown if any of the following conditions are met: ### Options -| Variable | Default | Description | -| ---------- | ------- | --------------------------------------------------------------- | -| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. | -| `disabled` | `false` | Disables the `elixir` module. | +| Variable | Default | Description | +| ---------- | --------------- | --------------------------------------------------------------- | +| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. | +| `style` | `"bold purple"` | The style for the module. | +| `disabled` | `false` | Disables the `elixir` module. | ### Example @@ -522,29 +523,6 @@ The module will be shown if any of the following conditions are met: symbol = " " ``` -## Erlang - -The `erlang` module shows the currently installed version of Erlang/OTP. -The module will be shown if any of the following conditions are met: - -- The current directory contains a `rebar.config` file. -- The current directory contains a `erlang.mk` file. - -### Options - -| Variable | Default | Description | -| ---------- | ------- | --------------------------------------------------------------- | -| `symbol` | `"🖧 "` | The symbol used before displaying the version of Erlang. | -| `disabled` | `false` | Disables the `erlang` module. | - -### Example - -```toml -# ~/.config/starship.toml - -[erlang] -symbol = "e " -``` ## Environment Variable The `env_var` module displays the current value of a selected environment variable. @@ -555,15 +533,15 @@ The module will be shown only if any of the following conditions are met: ### Options -| Variable | Default | Description | -| ---------- | ---------------- | ---------------------------------------------------------------------------- | -| `symbol` | | The symbol used before displaying the variable value. | -| `variable` | | The environment variable to be displayed. | -| `default` | | The default value to be displayed when the selected variable is not defined. | -| `prefix` | `""` | Prefix to display immediately before the variable value. | -| `suffix` | `""` | Suffix to display immediately after the variable value. | -| `style` | `"dimmed black"` | The style for the module. | -| `disabled` | `false` | Disables the `env_var` module. | +| Variable | Default | Description | +| ---------- | --------------------- | ---------------------------------------------------------------------------- | +| `symbol` | | The symbol used before displaying the variable value. | +| `variable` | | The environment variable to be displayed. | +| `default` | | The default value to be displayed when the selected variable is not defined. | +| `prefix` | `""` | Prefix to display immediately before the variable value. | +| `suffix` | `""` | Suffix to display immediately after the variable value. | +| `style` | `"dimmed bold black"` | The style for the module. | +| `disabled` | `false` | Disables the `env_var` module. | ### Example @@ -575,6 +553,31 @@ variable = "SHELL" default = "unknown shell" ``` +## Erlang + +The `erlang` module shows the currently installed version of Erlang/OTP. +The module will be shown if any of the following conditions are met: + +- The current directory contains a `rebar.config` file. +- The current directory contains a `erlang.mk` file. + +### Options + +| Variable | Default | Description | +| ---------- | ---------- | --------------------------------------------------------------- | +| `symbol` | `"🖧 "` | The symbol used before displaying the version of Erlang. | +| `style` | `bold red` | The style for this module. | +| `disabled` | `false` | Disables the `erlang` module. | + +### Example + +```toml +# ~/.config/starship.toml + +[erlang] +symbol = "e " +``` + ## Git Branch The `git_branch` module shows the active branch of the repo in your current directory. @@ -1077,7 +1080,7 @@ package, and shows its current version. The module currently supports `npm`, `ca | Variable | Default | Description | | ----------------- | ------------ | ---------------------------------------------------------- | | `symbol` | `"📦 "` | The symbol used before displaying the version the package. | -| `style` | `"bold red"` | The style for the module. | +| `style` | `"bold 208"` | The style for the module. | | `display_private` | `false` | Enable displaying version for packages marked as private. | | `disabled` | `false` | Disables the `package` module. | @@ -1104,7 +1107,7 @@ The module will be shown if any of the following conditions are met: | Variable | Default | Description | | ---------- | ------------ | ----------------------------------------------------- | | `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | -| `style` | `"bold red"` | The style for the module. | +| `style` | `"bold 147"` | The style for the module. | | `disabled` | `false` | Disables the `php` module. | ### Example @@ -1118,13 +1121,11 @@ symbol = "🔹 " ## Python -The `python` module shows the currently installed version of Python. +The `python` module shows the currently installed version of Python and the +current Python virtual environment if one is activated. -If `pyenv_version_name` is set to `true`, it will display the pyenv version name. - -Otherwise, it will display the version number from `python --version` -and show the current Python virtual environment if one is -activated. +If `pyenv_version_name` is set to `true`, it will display the pyenv version +name. Otherwise, it will display the version number from `python --version`. The module will be shown if any of the following conditions are met: