diff options
| author | Michael Davis | 2022-05-04 02:16:34 +0000 |
|---|---|---|
| committer | GitHub | 2022-05-04 02:16:34 +0000 |
| commit | f59b3b91c86d8f92ce72a4bb873bbb6aaaa4d2a9 (patch) | |
| tree | 6bbb1fbb1df947347f7c9e096660f502552fbeb8 | |
| parent | 25d128b5b3f173e3aa8b455194d128af35cc2a27 (diff) | |
rewrite auto-pairs docs (#2384)
| -rw-r--r-- | book/src/configuration.md | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/book/src/configuration.md b/book/src/configuration.md index 94134ed4..4d7e440a 100644 --- a/book/src/configuration.md +++ b/book/src/configuration.md @@ -90,16 +90,18 @@ available, which is not defined by default. ### `[editor.auto-pairs]` Section -Enable automatic insertion of pairs to parentheses, brackets, etc. Can be -a simple boolean value, or a specific mapping of pairs of single characters. +Enables automatic insertion of pairs to parentheses, brackets, etc. Can be a +simple boolean value, or a specific mapping of pairs of single characters. -| Key | Description | -| --- | ----------- | -| `false` | Completely disable auto pairing, regardless of language-specific settings -| `true` | Use the default pairs: <code>(){}[]''""``</code> -| Mapping of pairs | e.g. `{ "(" = ")", "{" = "}", ... }` +To disable auto-pairs altogether, set `auto-pairs` to `false`: -Example +```toml +[editor] +auto-pairs = false # defaults to `true` +``` + +The default pairs are <code>(){}[]''""``</code>, but these can be customized by +setting `auto-pairs` to a TOML table: ```toml [editor.auto-pairs] |