diff options
| -rw-r--r-- | CHANGELOG.md | 2 | ||||
| -rw-r--r-- | book/src/install.md | 2 | ||||
| -rw-r--r-- | book/src/keymap.md | 2 | ||||
| -rw-r--r-- | book/src/languages.md | 32 | ||||
| -rw-r--r-- | docs/releases.md | 4 |
5 files changed, 21 insertions, 21 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index 8f2775b2..9f7509b0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1596,7 +1596,7 @@ to distinguish it in bug reports.. - The `runtime/` directory is now properly detected on binary releases and on cargo run. `~/.config/helix/runtime` can also be used. -- Registers can now be selected via " (for example `"ay`) +- Registers can now be selected via " (for example, `"ay`) - Support for Nix files was added - Movement is now fully tested and matches Kakoune implementation - A per-file LSP symbol picker was added to space+s diff --git a/book/src/install.md b/book/src/install.md index 7483be29..0b5e1a30 100644 --- a/book/src/install.md +++ b/book/src/install.md @@ -161,7 +161,7 @@ Requirements: - The [Rust toolchain](https://www.rust-lang.org/tools/install) - The [Git version control system](https://git-scm.com/) -- A c++14 compatible compiler to build the tree-sitter grammars, for example GCC or Clang +- A C++14 compatible compiler to build the tree-sitter grammars, for example GCC or Clang If you are using the `musl-libc` standard library instead of `glibc` the following environment variable must be set during the build to ensure tree-sitter grammars can be loaded correctly: diff --git a/book/src/keymap.md b/book/src/keymap.md index e8b140c8..add73191 100644 --- a/book/src/keymap.md +++ b/book/src/keymap.md @@ -392,7 +392,7 @@ end = "no_op" Select mode echoes Normal mode, but changes any movements to extend selections rather than replace them. Goto motions are also changed to -extend, so that `vgl` for example extends the selection to the end of +extend, so that `vgl`, for example, extends the selection to the end of the line. Search is also affected. By default, `n` and `N` will remove the current diff --git a/book/src/languages.md b/book/src/languages.md index c334186b..5e56a332 100644 --- a/book/src/languages.md +++ b/book/src/languages.md @@ -7,24 +7,24 @@ in `languages.toml` files. There are three possible locations for a `languages.toml` file: -1. In the Helix source code, this lives in the +1. In the Helix source code, which lives in the [Helix repository](https://github.com/helix-editor/helix/blob/master/languages.toml). It provides the default configurations for languages and language servers. 2. In your [configuration directory](./configuration.md). This overrides values - from the built-in language configuration. For example to disable + from the built-in language configuration. For example, to disable auto-LSP-formatting in Rust: -```toml -# in <config_dir>/helix/languages.toml + ```toml + # in <config_dir>/helix/languages.toml -[language-server.mylang-lsp] -command = "mylang-lsp" + [language-server.mylang-lsp] + command = "mylang-lsp" -[[language]] -name = "rust" -auto-format = false -``` + [[language]] + name = "rust" + auto-format = false + ``` 3. In a `.helix` folder in your project. Language configuration may also be overridden local to a project by creating a `languages.toml` file in a @@ -128,7 +128,7 @@ These are the available options for a language server. A `format` sub-table within `config` can be used to pass extra formatting options to [Document Formatting Requests](https://github.com/microsoft/language-server-protocol/blob/gh-pages/_specifications/specification-3-17.md#document-formatting-request--leftwards_arrow_with_hook). -For example with typescript: +For example, with typescript: ```toml [language-server.typescript-language-server] @@ -147,8 +147,8 @@ Different languages can use the same language server instance, e.g. `typescript- In case multiple language servers are specified in the `language-servers` attribute of a `language`, it's often useful to only enable/disable certain language-server features for these language servers. -For example `efm-lsp-prettier` of the previous example is used only with a formatting command `prettier`, -so everything else should be handled by the `typescript-language-server` (which is configured by default) +As an example, `efm-lsp-prettier` of the previous example is used only with a formatting command `prettier`, +so everything else should be handled by the `typescript-language-server` (which is configured by default). The language configuration for typescript could look like this: ```toml @@ -166,10 +166,10 @@ language-servers = [ { name = "typescript-language-server", except-features = [ ``` Each requested LSP feature is prioritized in the order of the `language-servers` array. -For example the first `goto-definition` supported language server (in this case `typescript-language-server`) will be taken for the relevant LSP request (command `goto_definition`). +For example, the first `goto-definition` supported language server (in this case `typescript-language-server`) will be taken for the relevant LSP request (command `goto_definition`). The features `diagnostics`, `code-action`, `completion`, `document-symbols` and `workspace-symbols` are an exception to that rule, as they are working for all language servers at the same time and are merged together, if enabled for the language. -If no `except-features` or `only-features` is given all features for the language server are enabled. -If a language server itself doesn't support a feature the next language server array entry will be tried (and so on). +If no `except-features` or `only-features` is given, all features for the language server are enabled. +If a language server itself doesn't support a feature, the next language server array entry will be tried (and so on). The list of supported features is: diff --git a/docs/releases.md b/docs/releases.md index 6e7c37c6..84288675 100644 --- a/docs/releases.md +++ b/docs/releases.md @@ -1,7 +1,7 @@ ## Checklist Helix releases are versioned in the Calendar Versioning scheme: -`YY.0M(.MICRO)`, for example `22.05` for May of 2022. In these instructions +`YY.0M(.MICRO)`, for example, `22.05` for May of 2022. In these instructions we'll use `<tag>` as a placeholder for the tag being published. * Merge the changelog PR @@ -30,7 +30,7 @@ we'll use `<tag>` as a placeholder for the tag being published. The changelog is currently created manually by reading through commits in the log since the last release. GitHub's compare view is a nice way to approach -this. For example when creating the 22.07 release notes, this compare link +this. For example, when creating the 22.07 release notes, this compare link may be used ``` |