diff options
| author | Thomas O'Donnell <andytom@users.noreply.github.com> | 2020-10-06 09:09:06 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-10-06 02:09:06 -0500 |
| commit | 140009994dffdf6e975aa3f8452174f48407570a (patch) | |
| tree | 136fd9bf87c027213822686d69e9d281d084eb97 /docs | |
| parent | 47492d686be37d2f94f41e6663a9d7e7f14914df (diff) | |
docs(python): Update the python_binary option (#1731)
* docs(python): Update the python_binary option
Have updated the documentation to make the `python_binary` option a bit
more prominent, since this is becoming a more requested requirement now
that more and more systems don't have a default `python` command.
* Correct order of python options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/config/README.md | 39 |
1 files changed, 17 insertions, 22 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index a657e81a1..5fa675dd6 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -1883,15 +1883,16 @@ The module will be shown if any of the following conditions are met: ### Options -| Option | Default | Description | -| -------------------- | ------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `format` | `"via [${symbol}${pyenv_prefix}${version}( \\($virtualenv\\))]($style) "` | The format for the module. | -| `symbol` | `"🐍 "` | A format string representing the symbol of Python | -| `style` | `"yellow bold"` | The style for the module. | -| `pyenv_version_name` | `false` | Use pyenv to get Python version | -| `pyenv_prefix` | `pyenv ` | Prefix before pyenv version display, only used if pyenv is used | -| `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. | -| `disabled` | `false` | Disables the `python` module. | +| Option | Default | Description | +| -------------------- | ------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | +| `format` | `"via [${symbol}${pyenv_prefix}${version}( \\($virtualenv\\))]($style) "` | The format for the module. | +| `symbol` | `"🐍 "` | A format string representing the symbol of Python | +| `style` | `"yellow bold"` | The style for the module. | +| `pyenv_version_name` | `false` | Use pyenv to get Python version | +| `pyenv_prefix` | `pyenv ` | Prefix before pyenv version display, only used if pyenv is used | +| `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. | +| `python_binary` | `python` | Configures the python binary that Starship executes when getting the version. | +| `disabled` | `false` | Disables the `python` module. | ### Variables @@ -1903,33 +1904,27 @@ The module will be shown if any of the following conditions are met: | pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` | | virtualenv | `"venv"` | The current `virtualenv` name | -<details> -<summary>This module has some advanced configuration options.</summary> - -| Variable | Default | Description | -| --------------- | -------- | ----------------------------------------------------------------------------- | -| `python_binary` | `python` | Configures the python binary that Starship executes when getting the version. | -The `python_binary` variable changes the binary that Starship executes to get -the version of Python, it doesn't change the arguments that are used. +### Example ```toml # ~/.config/starship.toml [python] -python_binary = "python3" +symbol = "👾 " +pyenv_version_name = true ``` -</details> +Using the `python3` binary to get the version. -### Example +Note - The `python_binary` variable changes the binary that Starship executes +to get the version of Python, it doesn't change the arguments that are used. ```toml # ~/.config/starship.toml [python] -symbol = "👾 " -pyenv_version_name = true +python_binary = "python3" ``` ## Ruby |