diff options
| author | Thomas O'Donnell <andytom@users.noreply.github.com> | 2021-04-18 19:32:00 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-04-18 19:32:00 +0200 |
| commit | 3643cf63bea22f3f24cdac3cee1fba68810bb59d (patch) | |
| tree | 82407ff14a554c53c517e1ada7526f12c6cbb8cb /docs | |
| parent | b48d6679281503246d1a558e5385b113787c4ad1 (diff) | |
docs: Document the `command_timeout` option (#2604)
Have added documentation for the top level `command_timeout` option.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/config/README.md | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index 675906e60..1433f4691 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -151,11 +151,12 @@ This is the list of prompt-wide configuration options. ### Options -| Option | Default | Description | -| -------------- | ------------------------------ | ----------------------------------------------------- | -| `format` | [link](#default-prompt-format) | Configure the format of the prompt. | -| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). | -| `add_newline` | `true` | Inserts blank line between shell prompts. | +| Option | Default | Description | +| ----------------- | ------------------------------ | ------------------------------------------------------------ | +| `format` | [link](#default-prompt-format) | Configure the format of the prompt. | +| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). | +| `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). | +| `add_newline` | `true` | Inserts blank line between shell prompts. | ### Example |