From a5acfdbf104db82310b71da988ef8a5df43ffd49 Mon Sep 17 00:00:00 2001 From: Daniel Ebert Date: Tue, 19 Sep 2023 16:14:23 +0200 Subject: Add documentation for new indent computation --- book/src/guides/indent.md | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'book/src/guides/indent.md') diff --git a/book/src/guides/indent.md b/book/src/guides/indent.md index bd037bb0..a65ac5ac 100644 --- a/book/src/guides/indent.md +++ b/book/src/guides/indent.md @@ -12,6 +12,15 @@ Note that it matters where these added indents begin. For example, multiple indent level increases that start on the same line only increase the total indent level by 1. See [Capture types](#capture-types). +By default, Helix uses the `hybrid` indentation heuristic. This means that +indent queries are not used to compute the expected absolute indentation of a +line but rather the expected difference in indentation between the new and an +already existing line. This difference is then added to the actual indentation +of the already existing line. Since this makes errors in the indent queries +harder to find, it is recommended to disable it when testing via +`:set indent-heuristic tree-sitter`. The rest of this guide assumes that +the `tree-sitter` heuristic is used. + ## Indent queries When Helix is inserting a new line through `o`, `O`, or ``, to determine -- cgit v1.2.3-70-g09d2