Update soft_wrap config option documentation (#13457)

Closes https://github.com/zed-industries/zed/discussions/13440

Release Notes:

- N/A
This commit is contained in:
Kirill Bulatov 2024-06-24 11:52:52 +03:00 committed by GitHub
parent 10f7ca65cf
commit d2a2faf7a2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 9 additions and 8 deletions

View file

@ -477,16 +477,16 @@
// or falling back to formatting via language server: // or falling back to formatting via language server:
// "formatter": "auto" // "formatter": "auto"
"formatter": "auto", "formatter": "auto",
// How to soft-wrap long lines of text. This setting can take // How to soft-wrap long lines of text.
// three values: // Possible values:
// //
// 1. Do not soft wrap. // 1. Do not soft wrap.
// "soft_wrap": "none", // "soft_wrap": "none",
// 2. Prefer a single line generally, unless an overly long line is encountered. // 2. Prefer a single line generally, unless an overly long line is encountered.
// "soft_wrap": "prefer_line", // "soft_wrap": "prefer_line",
// 3. Soft wrap lines that overflow the editor: // 3. Soft wrap lines that overflow the editor.
// "soft_wrap": "editor_width", // "soft_wrap": "editor_width",
// 4. Soft wrap lines at the preferred line length // 4. Soft wrap lines at the preferred line length.
// "soft_wrap": "preferred_line_length", // "soft_wrap": "preferred_line_length",
"soft_wrap": "prefer_line", "soft_wrap": "prefer_line",
// 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

View file

@ -1110,13 +1110,14 @@ These values take in the same options as the root-level settings with the same n
- Description: Whether or not to automatically wrap lines of text to fit editor / preferred width. - Description: Whether or not to automatically wrap lines of text to fit editor / preferred width.
- Setting: `soft_wrap` - Setting: `soft_wrap`
- Default: `none` - Default: `prefer_line`
**Options** **Options**
1. `editor_width` 1. `none` to stop the soft-wrapping
2. `preferred_line_length` 2. `prefer_line` to avoid wrapping generally, unless the line is too long
3. `none` 3. `editor_width` to wrap lines that overflow the editor width
4. `preferred_line_length` to wrap lines that overflow `preferred_line_length` config value
## Wrap Guides (Vertical Rulers) ## Wrap Guides (Vertical Rulers)