Skip to content

Commit 7c4ff9c

Browse files
authored
editor.md: Consistently use double quotes when describing default values (#14638)
1 parent 92a4754 commit 7c4ff9c

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

book/src/editor.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@
2727
|--|--|---------|
2828
| `scrolloff` | Number of lines of padding around the edge of the screen when scrolling | `5` |
2929
| `mouse` | Enable mouse mode | `true` |
30-
| `default-yank-register` | Default register used for yank/paste | `"` |
30+
| `default-yank-register` | Default register used for yank/paste | `'"'` |
3131
| `middle-click-paste` | Middle click paste support | `true` |
3232
| `scroll-lines` | Number of lines to scroll per scroll wheel step | `3` |
3333
| `shell` | Shell to use when running external commands | Unix: `["sh", "-c"]`<br/>Windows: `["cmd", "/C"]` |
34-
| `line-number` | Line number display: `absolute` simply shows each line's number, while `relative` shows the distance from the current line. When unfocused or in insert mode, `relative` will still show absolute line numbers | `absolute` |
34+
| `line-number` | Line number display: `absolute` simply shows each line's number, while `relative` shows the distance from the current line. When unfocused or in insert mode, `relative` will still show absolute line numbers | `"absolute"` |
3535
| `cursorline` | Highlight all lines with a cursor | `false` |
3636
| `cursorcolumn` | Highlight all columns with a cursor | `false` |
3737
| `continue-comments` | if helix should automatically add a line comment token if you create a new line inside a comment. | `true` |
@@ -48,23 +48,23 @@
4848
| `true-color` | Whether to override automatic detection of terminal truecolor support in the event of a false negative | `false` |
4949
| `undercurl` | Whether to override automatic detection of terminal undercurl support in the event of a false negative | `false` |
5050
| `rulers` | List of column positions at which to display the rulers. Can be overridden by language specific `rulers` in `languages.toml` file | `[]` |
51-
| `bufferline` | Renders a line at the top of the editor displaying open buffers. Can be `always`, `never` or `multiple` (only shown if more than one buffer is in use) | `never` |
51+
| `bufferline` | Renders a line at the top of the editor displaying open buffers. Can be `always`, `never` or `multiple` (only shown if more than one buffer is in use) | `"never"` |
5252
| `color-modes` | Whether to color the mode indicator with different colors depending on the mode itself | `false` |
5353
| `text-width` | Maximum line length. Used for the `:reflow` command and soft-wrapping if `soft-wrap.wrap-at-text-width` is set | `80` |
5454
| `workspace-lsp-roots` | Directories relative to the workspace root that are treated as LSP roots. Should only be set in `.helix/config.toml` | `[]` |
55-
| `default-line-ending` | The line ending to use for new documents. Can be `native`, `lf`, `crlf`, `ff`, `cr` or `nel`. `native` uses the platform's native line ending (`crlf` on Windows, otherwise `lf`). | `native` |
55+
| `default-line-ending` | The line ending to use for new documents. Can be `native`, `lf`, `crlf`, `ff`, `cr` or `nel`. `native` uses the platform's native line ending (`crlf` on Windows, otherwise `lf`). | `"native"` |
5656
| `insert-final-newline` | Whether to automatically insert a trailing line-ending on write if missing | `true` |
5757
| `atomic-save` | Whether to use atomic operations to write documents to disk. This prevents data loss if the editor is interrupted while writing the file, but may confuse some file watching/hot reloading programs. | `true` |
5858
| `trim-final-newlines` | Whether to automatically remove line-endings after the final one on write | `false` |
5959
| `trim-trailing-whitespace` | Whether to automatically remove whitespace preceding line endings on write | `false` |
60-
| `popup-border` | Draw border around `popup`, `menu`, `all`, or `none` | `none` |
61-
| `indent-heuristic` | How the indentation for a newly inserted line is computed: `simple` just copies the indentation level from the previous line, `tree-sitter` computes the indentation based on the syntax tree and `hybrid` combines both approaches. If the chosen heuristic is not available, a different one will be used as a fallback (the fallback order being `hybrid` -> `tree-sitter` -> `simple`). | `hybrid`
62-
| `jump-label-alphabet` | The characters that are used to generate two character jump labels. Characters at the start of the alphabet are used first. | `"abcdefghijklmnopqrstuvwxyz"`
63-
| `end-of-line-diagnostics` | Minimum severity of diagnostics to render at the end of the line. Set to `disable` to disable entirely. Refer to the setting about `inline-diagnostics` for more details | `"hint"`
60+
| `popup-border` | Draw border around `popup`, `menu`, `all`, or `none` | `"none"` |
61+
| `indent-heuristic` | How the indentation for a newly inserted line is computed: `simple` just copies the indentation level from the previous line, `tree-sitter` computes the indentation based on the syntax tree and `hybrid` combines both approaches. If the chosen heuristic is not available, a different one will be used as a fallback (the fallback order being `hybrid` -> `tree-sitter` -> `simple`). | `"hybrid"` |
62+
| `jump-label-alphabet` | The characters that are used to generate two character jump labels. Characters at the start of the alphabet are used first. | `"abcdefghijklmnopqrstuvwxyz"` |
63+
| `end-of-line-diagnostics` | Minimum severity of diagnostics to render at the end of the line. Set to `disable` to disable entirely. Refer to the setting about `inline-diagnostics` for more details | `"hint"` |
6464
| `clipboard-provider` | Which API to use for clipboard interaction. One of `pasteboard` (MacOS), `wayland`, `x-clip`, `x-sel`, `win32-yank`, `termux`, `tmux`, `windows`, `termcode`, `none`, or a custom command set. | Platform and environment specific. |
6565
| `editor-config` | Whether to read settings from [EditorConfig](https://editorconfig.org) files | `true` |
6666
| `rainbow-brackets` | Whether to render rainbow colors for matching brackets. Requires tree-sitter `rainbows.scm` queries for the language. | `false` |
67-
| `kitty-keyboard-protocol` | Whether to enable Kitty Keyboard Protocol. Can be `enabled`, `disabled` or `auto` | `auto` |
67+
| `kitty-keyboard-protocol` | Whether to enable Kitty Keyboard Protocol. Can be `enabled`, `disabled` or `auto` | `"auto"` |
6868

6969
### `[editor.clipboard-provider]` Section
7070

@@ -180,11 +180,11 @@ Valid values for these options are `block`, `bar`, `underline`, or `hidden`.
180180
> 💡 Due to limitations of the terminal environment, only the primary cursor can
181181
> change shape.
182182
183-
| Key | Description | Default |
184-
| --- | ----------- | ------- |
185-
| `normal` | Cursor shape in [normal mode][normal mode] | `block` |
186-
| `insert` | Cursor shape in [insert mode][insert mode] | `block` |
187-
| `select` | Cursor shape in [select mode][select mode] | `block` |
183+
| Key | Description | Default |
184+
| --- | ----------- | ------- |
185+
| `normal` | Cursor shape in [normal mode][normal mode] | `"block"` |
186+
| `insert` | Cursor shape in [insert mode][insert mode] | `"block"` |
187+
| `select` | Cursor shape in [select mode][select mode] | `"block"` |
188188

189189
[normal mode]: ./keymap.md#normal-mode
190190
[insert mode]: ./keymap.md#insert-mode
@@ -312,7 +312,7 @@ Options for rendering whitespace with visible characters. Use `:set whitespace.r
312312

313313
| Key | Description | Default |
314314
|-----|-------------|---------|
315-
| `render` | Whether to render whitespace. May either be `all` or `none`, or a table with sub-keys `space`, `nbsp`, `nnbsp`, `tab`, and `newline` | `none` |
315+
| `render` | Whether to render whitespace. May either be `all` or `none`, or a table with sub-keys `space`, `nbsp`, `nnbsp`, `tab`, and `newline` | `"none"` |
316316
| `characters` | Literal characters to use when rendering whitespace. Sub-keys may be any of `tab`, `space`, `nbsp`, `nnbsp`, `newline` or `tabpad` | See example below |
317317

318318
Example
@@ -344,7 +344,7 @@ Options for rendering vertical indent guides.
344344
| Key | Description | Default |
345345
| --- | --- | --- |
346346
| `render` | Whether to render indent guides | `false` |
347-
| `character` | Literal character to use for rendering the indent guide | `` |
347+
| `character` | Literal character to use for rendering the indent guide | `"│"` |
348348
| `skip-levels` | Number of indent levels to skip | `0` |
349349

350350
Example:
@@ -422,7 +422,7 @@ Options for soft wrapping lines that exceed the view width:
422422
| `enable` | Whether soft wrapping is enabled. | `false` |
423423
| `max-wrap` | Maximum free space left at the end of the line. | `20` |
424424
| `max-indent-retain` | Maximum indentation to carry over when soft wrapping a line. | `40` |
425-
| `wrap-indicator` | Text inserted before soft wrapped lines, highlighted with `ui.virtual.wrap` | `` |
425+
| `wrap-indicator` | Text inserted before soft wrapped lines, highlighted with `ui.virtual.wrap` | `"↪ "` |
426426
| `wrap-at-text-width` | Soft wrap at `text-width` instead of using the full viewport size. | `false` |
427427

428428
Example:

0 commit comments

Comments
 (0)