on master help sign in
rewrite auto-pairs docs (#2384)
commitf59b3b91c86d8f92ce72a4bb873bbb6aaaa4d2a9 authorMichael Davis <mcarsondavis@gmail.com> dateTue 3 May 2022, 21:16 (4 years ago) parent25d128b
1 file changed+10−8
book/src/configuration.md+10−8
book/src/configuration.md+10−8
@@ -90,16 +90,18 @@ available, which is not defined by default.
9090
9191### `[editor.auto-pairs]` Section
9292
93−Enable automatic insertion of pairs to parentheses, brackets, etc. Can be
94−a simple boolean value, or a specific mapping of pairs of single characters.
93+Enables automatic insertion of pairs to parentheses, brackets, etc. Can be a
94+simple boolean value, or a specific mapping of pairs of single characters.
9595
96−| Key | Description |
97−| --- | ----------- |
98−| `false` | Completely disable auto pairing, regardless of language-specific settings
99−| `true` | Use the default pairs: <code>(){}[]''""``</code>
100−| Mapping of pairs | e.g. `{ "(" = ")", "{" = "}", ... }`
96+To disable auto-pairs altogether, set `auto-pairs` to `false`:
10197
102−Example
98+```toml
99+[editor]
100+auto-pairs = false # defaults to `true`
101+```
102+
103+The default pairs are <code>(){}[]''""``</code>, but these can be customized by
104+setting `auto-pairs` to a TOML table:
103105
104106```toml
105107[editor.auto-pairs]