Skip to content

Commit

Permalink
Improve option description
Browse files Browse the repository at this point in the history
More discoverable and consistent with rest of docs and codebase

Co-authored-by: Michael Davis <[email protected]
  • Loading branch information
zqianem committed Sep 3, 2023
1 parent c89cd10 commit 2d4c59a
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion book/src/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Its settings will be merged with the configuration directory `config.toml` and t
| `text-width` | Maximum line length. Used for the `:reflow` command and soft-wrapping if `soft-wrap.wrap-at-text-width` is set | `80` |
| `workspace-lsp-roots` | Directories relative to the workspace root that are treated as LSP roots. Should only be set in `.helix/config.toml` | `[]` |
| `default-line-ending` | The line ending to use for new documents. Can be `native`, `lf`, `crlf`, `ff`, `cr` or `nel`. `native` uses the platform's native line ending (`crlf` on Windows, otherwise `lf`). | `native` |
| `insert-final-newline` | Whether to automatically insert a final newline on write if missing | `false` |
| `insert-final-newline` | Whether to automatically insert a trailing line-ending on write if missing | `false` |

### `[editor.statusline]` Section

Expand Down
2 changes: 1 addition & 1 deletion helix-view/src/editor.rs
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,7 @@ pub struct Config {
pub workspace_lsp_roots: Vec<PathBuf>,
/// Which line ending to choose for new documents. Defaults to `native`. i.e. `crlf` on Windows, otherwise `lf`.
pub default_line_ending: LineEndingConfig,
/// Whether to automatically insert a final newline on write if missing. Defaults to `false`.
/// Whether to automatically insert a trailing line-ending on write if missing. Defaults to `false`.
pub insert_final_newline: bool,
/// Enables smart tab
pub smart_tab: Option<SmartTabConfig>,
Expand Down

0 comments on commit 2d4c59a

Please sign in to comment.