docs: wrap_guides (#12992)

- Add 'wrap_guides' to website config docs.
- Add the word 'ruler' to improve searchability.
This commit is contained in:
Peter Tripp 2024-06-14 09:48:25 -04:00 committed by GitHub
parent 902d7150fe
commit 0f59607100
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 19 additions and 9 deletions

View file

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

View file

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

View file

@ -1117,6 +1117,16 @@ These values take in the same options as the root-level settings with the same n
2. `preferred_line_length` 2. `preferred_line_length`
3. `none` 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 ## Tab Size
- Description: The number of spaces to use for each tab character. - Description: The number of spaces to use for each tab character.