docs: wrap_guides (#12992)

Peter Tripp created 2 years ago

- Add 'wrap_guides' to website config docs.
- Add the word 'ruler' to improve searchability.

Change summary

assets/settings/default.json             |  8 ++++----
crates/language/src/language_settings.rs | 10 +++++-----
docs/src/configuring-zed.md              | 10 ++++++++++
3 files changed, 19 insertions(+), 9 deletions(-)

Detailed changes

assets/settings/default.json

@@ -119,10 +119,10 @@
   // The debounce delay before re-querying the language server for completion
   // documentation when not included in original completion list.
   "completion_documentation_secondary_query_debounce": 300,
-  // Whether to show wrap guides in the editor. Setting this to true will
-  // show a guide at the 'preferred_line_length' value if 'soft_wrap' is set to
-  // 'preferred_line_length', and will show any additional guides as specified
-  // by the 'wrap_guides' setting.
+  // Whether to show wrap guides (vertical rulers) in the editor.
+  // Setting this to true will show a guide at the 'preferred_line_length' value
+  // if softwrap is set to 'preferred_line_length', and will show any
+  // additional guides as specified by the 'wrap_guides' setting.
   "show_wrap_guides": true,
   // Character counts at which to show wrap guides in the editor.
   "wrap_guides": [],

crates/language/src/language_settings.rs

@@ -71,12 +71,12 @@ pub struct LanguageSettings {
     /// The column at which to soft-wrap lines, for buffers where soft-wrap
     /// is enabled.
     pub preferred_line_length: u32,
-    /// Whether to show wrap guides in the editor. Setting this to true will
-    /// show a guide at the 'preferred_line_length' value if softwrap is set to
-    /// 'preferred_line_length', and will show any additional guides as specified
-    /// by the 'wrap_guides' setting.
+    // Whether to show wrap guides (vertical rulers) in the editor.
+    // Setting this to true will show a guide at the 'preferred_line_length' value
+    // if softwrap is set to 'preferred_line_length', and will show any
+    // additional guides as specified by the 'wrap_guides' setting.
     pub show_wrap_guides: bool,
-    /// Character counts at which to show wrap guides in the editor.
+    /// Character counts at which to show wrap guides (vertical rulers) in the editor.
     pub wrap_guides: Vec<usize>,
     /// Indent guide related settings.
     pub indent_guides: IndentGuideSettings,

docs/src/configuring-zed.md

@@ -1117,6 +1117,16 @@ These values take in the same options as the root-level settings with the same n
 2. `preferred_line_length`
 3. `none`
 
+## Wrap Guides (Vertical Rulers)
+
+- Description: Where to display vertical rulers as wrap-guides. Disable by setting `show_wrap_guides` to `false`.
+- Setting: `wrap_guides`
+- Default: []
+
+**Options**
+
+List of `integer` column numbers
+
 ## Tab Size
 
 - Description: The number of spaces to use for each tab character.