Skip to content

Commit dcf9a4e

Browse files
committed
docs: indent treesitter field not recommanded
1 parent ce10f64 commit dcf9a4e

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

docs/en/chunk.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ local default_conf = {
3535
The unique configuration options are `use_treesitter`, `chars`, `textobject`, `max_file_size`, `error_sign`, `duration` and `delay`
3636

3737
- `use_treesitter` is used to control whether to use treesitter to highlight code blocks. The default is true.
38-
If this field is set to true, it finds the matching node type by searching the tree nodes from bottom to top to obtain the corresponding chunk range. If set to false, it will use Vim's `searchpair` to find the nearest braces to infer the position (which is why it cannot be used normally in scripting languages like Python).
38+
If this field is set to true, it finds the matching node type by searching the tree nodes from bottom to top to obtain the corresponding chunk range. If set to false, it will use Vim's `searchpair` to find the nearest braces to infer the position (which is why it cannot be used normally in scripting languages like Python). And after `v1.2.1`, it's no longer recommended to use `treesitter` to get indent.
3939

4040
- `chars` is a table, where the characters in it are used to render the chunk. This table contains five parts:
4141

docs/zh_CN/indent.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ local default_conf = {
2121

2222
独有的配置为 `use_treesitter``chars``ahead_lines`
2323

24-
- `use_treesitter` 是用来控制是否使用 treesitter 来判断 indent 的层数,默认为 false(因为性能问题)。如果你对缩进的精确要求很高,你可以尝试设置为 true,详情见这个 [issue](https://github.com/shellRaining/hlchunk.nvim/issues/77#issuecomment-1817530409)
24+
- `use_treesitter` 是用来控制是否使用 treesitter 来判断 indent 的层数,默认为 false(因为性能问题)。如果你对缩进的精确要求很高,你可以尝试设置为 true,详情见这个 [issue](https://github.com/shellRaining/hlchunk.nvim/issues/77#issuecomment-1817530409)。同时在 `v1.2.1` 版本之后,已经不再推荐使用 treesitter 来获取缩进。
2525

2626
- `chars` 是一个表,其中的字符用来指示用什么字符来渲染 indent line,你可以尝试设置为下面这样:
2727

0 commit comments

Comments
 (0)