From f59b3b91c86d8f92ce72a4bb873bbb6aaaa4d2a9 Mon Sep 17 00:00:00 2001 From: Michael Davis Date: Tue, 3 May 2022 21:16:34 -0500 Subject: [PATCH] rewrite auto-pairs docs (#2384) --- book/src/configuration.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/book/src/configuration.md b/book/src/configuration.md index 94134ed4d..4d7e440a0 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: (){}[]''""`` -| 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 (){}[]''""``, but these can be customized by +setting `auto-pairs` to a TOML table: ```toml [editor.auto-pairs]