Update the whitespace docs in the default settings file (#12717)

Kirill Bulatov created 2 years ago

Change summary

assets/settings/default.json             | 15 +++++++--------
crates/language/src/language_settings.rs |  2 +-
2 files changed, 8 insertions(+), 9 deletions(-)

Detailed changes

assets/settings/default.json

@@ -131,14 +131,7 @@
   // The default number of lines to expand excerpts in the multibuffer by.
   "expand_excerpt_lines": 3,
   // Globs to match against file paths to determine if a file is private.
-  "private_files": [
-    "**/.env*",
-    "**/*.pem",
-    "**/*.key",
-    "**/*.cert",
-    "**/*.crt",
-    "**/secrets.yml"
-  ],
+  "private_files": ["**/.env*", "**/*.pem", "**/*.key", "**/*.cert", "**/*.crt", "**/secrets.yml"],
   // Whether to use additional LSP queries to format (and amend) the code after
   // every "trigger" symbol input, defined by LSP server capabilities.
   "use_on_type_format": true,
@@ -164,6 +157,12 @@
   //   "none"
   // 3. Draw all invisible symbols:
   //   "all"
+  // 4. Draw whitespaces at boundaries only:
+  //   "boundaries"
+  // For a whitespace to be on a boundary, any of the following conditions need to be met:
+  // - It is a tab
+  // - It is adjacent to an edge (start or end)
+  // - It is adjacent to a whitespace (left or right)
   "show_whitespaces": "selection",
   // Settings related to calls in Zed
   "calls": {

crates/language/src/language_settings.rs

@@ -391,7 +391,7 @@ pub enum ShowWhitespaceSetting {
     None,
     /// Draw all invisible symbols.
     All,
-    /// Draw whitespace only at boundaries.
+    /// Draw whitespaces at boundaries only.
     ///
     /// For a whitespace to be on a boundary, any of the following conditions need to be met:
     /// - It is a tab