From 3643cf63bea22f3f24cdac3cee1fba68810bb59d Mon Sep 17 00:00:00 2001 From: Thomas O'Donnell Date: Sun, 18 Apr 2021 19:32:00 +0200 Subject: [PATCH] docs: Document the `command_timeout` option (#2604) Have added documentation for the top level `command_timeout` option. --- docs/config/README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/config/README.md b/docs/config/README.md index 675906e6..1433f469 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