git.iko.soy/helix
on master help sign in
misc doc fixes/improvements (#7282)
27891cdTshepang Mbambo
CHANGELOG.md+1−1
compare with master
unifiedsplit
@@ -1596,7 +1596,7 @@ to distinguish it in bug reports..
1596
1596
1597- The `runtime/` directory is now properly detected on binary releases and
1597- The `runtime/` directory is now properly detected on binary releases and
1598 on cargo run. `~/.config/helix/runtime` can also be used.
1598 on cargo run. `~/.config/helix/runtime` can also be used.
1599−- Registers can now be selected via " (for example `"ay`)
1599+- Registers can now be selected via " (for example, `"ay`)
1600- Support for Nix files was added
1600- Support for Nix files was added
1601- Movement is now fully tested and matches Kakoune implementation
1601- Movement is now fully tested and matches Kakoune implementation
1602- A per-file LSP symbol picker was added to space+s
1602- A per-file LSP symbol picker was added to space+s
book/src/install.md+1−1
@@ -161,7 +161,7 @@ Requirements:
161
161
162- The [Rust toolchain](https://www.rust-lang.org/tools/install)
162- The [Rust toolchain](https://www.rust-lang.org/tools/install)
163- The [Git version control system](https://git-scm.com/)
163- The [Git version control system](https://git-scm.com/)
164−- A c++14 compatible compiler to build the tree-sitter grammars, for example GCC or Clang
164+- A C++14 compatible compiler to build the tree-sitter grammars, for example GCC or Clang
165
165
166If 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:
166If 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:
167
167
book/src/keymap.md+1−1
@@ -392,7 +392,7 @@ end = "no_op"
392
392
393Select mode echoes Normal mode, but changes any movements to extend
393Select mode echoes Normal mode, but changes any movements to extend
394selections rather than replace them. Goto motions are also changed to
394selections rather than replace them. Goto motions are also changed to
395−extend, so that `vgl` for example extends the selection to the end of
395+extend, so that `vgl`, for example, extends the selection to the end of
396the line.
396the line.
397
397
398Search is also affected. By default, `n` and `N` will remove the current
398Search is also affected. By default, `n` and `N` will remove the current
book/src/languages.md+16−16
@@ -7,24 +7,24 @@ in `languages.toml` files.
7
7
8There are three possible locations for a `languages.toml` file:
8There are three possible locations for a `languages.toml` file:
9
9
10−1. In the Helix source code, this lives in the
10+1. In the Helix source code, which lives in the
11 [Helix repository](https://github.com/helix-editor/helix/blob/master/languages.toml).
11 [Helix repository](https://github.com/helix-editor/helix/blob/master/languages.toml).
12 It provides the default configurations for languages and language servers.
12 It provides the default configurations for languages and language servers.
13
13
142. In your [configuration directory](./configuration.md). This overrides values
142. In your [configuration directory](./configuration.md). This overrides values
15− from the built-in language configuration. For example to disable
15+ from the built-in language configuration. For example, to disable
16 auto-LSP-formatting in Rust:
16 auto-LSP-formatting in Rust:
17
17
18−```toml
18+ ```toml
19−# in <config_dir>/helix/languages.toml
19+ # in <config_dir>/helix/languages.toml
20
20
21−[language-server.mylang-lsp]
21+ [language-server.mylang-lsp]
22−command = "mylang-lsp"
22+ command = "mylang-lsp"
23
23
24−[[language]]
24+ [[language]]
25−name = "rust"
25+ name = "rust"
26−auto-format = false
26+ auto-format = false
27−```
27+ ```
28
28
293. In a `.helix` folder in your project. Language configuration may also be
293. In a `.helix` folder in your project. Language configuration may also be
30 overridden local to a project by creating a `languages.toml` file in a
30 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.
128
128
129A `format` sub-table within `config` can be used to pass extra formatting options to
129A `format` sub-table within `config` can be used to pass extra formatting options to
130[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).
130[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).
131−For example with typescript:
131+For example, with typescript:
132
132
133```toml
133```toml
134[language-server.typescript-language-server]
134[language-server.typescript-language-server]
@@ -147,8 +147,8 @@ Different languages can use the same language server instance, e.g. `typescript-
147In case multiple language servers are specified in the `language-servers` attribute of a `language`,
147In case multiple language servers are specified in the `language-servers` attribute of a `language`,
148it's often useful to only enable/disable certain language-server features for these language servers.
148it's often useful to only enable/disable certain language-server features for these language servers.
149
149
150−For example `efm-lsp-prettier` of the previous example is used only with a formatting command `prettier`,
150+As an example, `efm-lsp-prettier` of the previous example is used only with a formatting command `prettier`,
151−so everything else should be handled by the `typescript-language-server` (which is configured by default)
151+so everything else should be handled by the `typescript-language-server` (which is configured by default).
152The language configuration for typescript could look like this:
152The language configuration for typescript could look like this:
153
153
154```toml
154```toml
@@ -166,10 +166,10 @@ language-servers = [ { name = "typescript-language-server", except-features = [
166```
166```
167
167
168Each requested LSP feature is prioritized in the order of the `language-servers` array.
168Each requested LSP feature is prioritized in the order of the `language-servers` array.
169−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`).
169+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`).
170The 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.
170The 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.
171−If no `except-features` or `only-features` is given all features for the language server are enabled.
171+If no `except-features` or `only-features` is given, all features for the language server are enabled.
172−If a language server itself doesn't support a feature the next language server array entry will be tried (and so on).
172+If a language server itself doesn't support a feature, the next language server array entry will be tried (and so on).
173
173
174The list of supported features is:
174The list of supported features is:
175
175
docs/releases.md+2−2
@@ -1,7 +1,7 @@
1## Checklist
1## Checklist
2
2
3Helix releases are versioned in the Calendar Versioning scheme:
3Helix releases are versioned in the Calendar Versioning scheme:
4−`YY.0M(.MICRO)`, for example `22.05` for May of 2022. In these instructions
4+`YY.0M(.MICRO)`, for example, `22.05` for May of 2022. In these instructions
5we'll use `<tag>` as a placeholder for the tag being published.
5we'll use `<tag>` as a placeholder for the tag being published.
6
6
7* Merge the changelog PR
7* Merge the changelog PR
@@ -30,7 +30,7 @@ we'll use `<tag>` as a placeholder for the tag being published.
30
30
31The changelog is currently created manually by reading through commits in the
31The changelog is currently created manually by reading through commits in the
32log since the last release. GitHub's compare view is a nice way to approach
32log since the last release. GitHub's compare view is a nice way to approach
33−this. For example when creating the 22.07 release notes, this compare link
33+this. For example, when creating the 22.07 release notes, this compare link
34may be used
34may be used
35
35
36```
36```