diff options
| author | Tim Siegel | 2022-10-10 18:32:05 +0000 |
|---|---|---|
| committer | Michael Davis | 2022-10-12 23:12:54 +0000 |
| commit | 425df93fb88ecfd0f87025705de348051cd40ccf (patch) | |
| tree | d0593762ba85e2ec4c5f2c1495d1acee61415c49 /book/src/themes.md | |
| parent | e542f2e08f143ef2fd59ca2957842ba82338b63f (diff) | |
book: Refer to keys by key names, not representations
This is an attempt to clean up the inconsistent way that keys are
written in various places. These rules require the fewest changes to the
existing text.
Use the "Key name", as defined in remapping.md, which uses
"Some-Modifiers-PascalCaseKey". The "Representation", which uses
"S-M-lowercasekey", is only used for configuration entries.
For key combinations which do not present a popup, just present the keys
one after the other, with no intervening space, like `]p`.
For key combinations which present a popup, separate them with ` + `,
like `Space + f`.
The Ctrl modifier is called Ctrl, not Control.
Diffstat (limited to 'book/src/themes.md')
| -rw-r--r-- | book/src/themes.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/book/src/themes.md b/book/src/themes.md index 2563bb85..d1244596 100644 --- a/book/src/themes.md +++ b/book/src/themes.md @@ -244,7 +244,7 @@ These scopes are used for theming the editor interface. | `ui.statusline.insert` | Statusline mode during insert mode ([only if `editor.color-modes` is enabled][editor-section]) | | `ui.statusline.select` | Statusline mode during select mode ([only if `editor.color-modes` is enabled][editor-section]) | | `ui.statusline.separator` | Separator character in statusline | -| `ui.popup` | Documentation popups (e.g space-k) | +| `ui.popup` | Documentation popups (e.g Space + k) | | `ui.popup.info` | Prompt for multiple key options | | `ui.window` | Border lines separating splits | | `ui.help` | Description box for commands | @@ -252,7 +252,7 @@ These scopes are used for theming the editor interface. | `ui.text.focus` | | | `ui.text.info` | The key: command text in `ui.popup.info` boxes | | `ui.virtual.ruler` | Ruler columns (see the [`editor.rulers` config][editor-section]) | -| `ui.virtual.whitespace` | Visible white-space characters | +| `ui.virtual.whitespace` | Visible whitespace characters | | `ui.virtual.indent-guide` | Vertical indent width guides | | `ui.menu` | Code and command completion menus | | `ui.menu.selected` | Selected autocomplete item | |