summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorThomas O'Donnell <andytom@users.noreply.github.com>2020-05-14 00:19:21 +0200
committerGitHub <noreply@github.com>2020-05-13 18:19:21 -0400
commit9251778a9c2c57ff67fc89bc7cb82f3eff3ef11f (patch)
treef974f18c6a14a7380155d136aac38d022851a125
parent5dcdba5135ce65236053b01e9f519c8bbf9e713d (diff)
docs: correct the configuration docs (#1195)
-rw-r--r--docs/config/README.md81
1 files changed, 41 insertions, 40 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,57 +523,59 @@ The module will be shown if any of the following conditions are met:
symbol = " "
```
-## Erlang
+## Environment Variable
-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 `env_var` module displays the current value of a selected environment variable.
+The module will be shown only if any of the following conditions are met:
-- The current directory contains a `rebar.config` file.
-- The current directory contains a `erlang.mk` file.
+- The `variable` configuration option matches an existing environment variable
+- The `variable` configuration option is not defined, but the `default` configuration option is
### Options
-| Variable | Default | Description |
-| ---------- | ------- | --------------------------------------------------------------- |
-| `symbol` | `"🖧 "` | The symbol used before displaying the version of Erlang. |
-| `disabled` | `false` | Disables the `erlang` 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
```toml
# ~/.config/starship.toml
-[erlang]
-symbol = "e "
+[env_var]
+variable = "SHELL"
+default = "unknown shell"
```
-## Environment Variable
-The `env_var` module displays the current value of a selected environment variable.
-The module will be shown only if any of the following conditions are met:
+## Erlang
-- The `variable` configuration option matches an existing environment variable
-- The `variable` configuration option is not defined, but the `default` configuration option is
+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 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 version of Erlang. |
+| `style` | `bold red` | The style for this module. |
+| `disabled` | `false` | Disables the `erlang` module. |
### Example
```toml
# ~/.config/starship.toml
-[env_var]
-variable = "SHELL"
-default = "unknown shell"
+[erlang]
+symbol = "e "
```
## Git Branch
@@ -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.
-
-If `pyenv_version_name` is set to `true`, it will display the pyenv version name.
+The `python` module shows the currently installed version of Python and the
+current Python virtual environment if one is activated.
-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: