diff options
| author | Artur Daschevici <a.daschevici@gmail.com> | 2021-02-23 17:50:36 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-23 18:50:36 +0100 |
| commit | 5a29765f81b6c322a2a45c73fd14793a14395301 (patch) | |
| tree | cfbbfd2a029dd06ddcafd8cf2777411675a9fc1f | |
| parent | 36351e4b2f3b8acd610af2db7bb0afa847fe13eb (diff) | |
docs: Clarify wording on add_newline option (#2308)
* docs: Clarify wording on add_newline option
* docs: Replace new line with blank line
| -rw-r--r-- | docs/config/README.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index 62a20d737..9502d0ddb 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -9,8 +9,8 @@ mkdir -p ~/.config && touch ~/.config/starship.toml All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file: ```toml -# Don't print a new line at the start of the prompt -add_newline = false +# Inserts a blank line between shell prompts +add_newline = true # Replace the "❯" symbol in the prompt with "➜" [character] # The name of the module we are configuring is "character" @@ -155,7 +155,7 @@ This is the list of prompt-wide configuration options. | -------------- | ------------------------------ | ----------------------------------------------------- | | `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` | Add a new line before the start of the prompt. | +| `add_newline` | `true` | Inserts blank line between shell prompts. | ### Example @@ -171,7 +171,7 @@ format = """ # Wait 10 milliseconds for starship to check files under the current directory. scan_timeout = 10 -# Disable the newline at the start of the prompt +# Disable the blank line at the start of the prompt add_newline = false ``` |