aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSantos Gallegos <stsewd@protonmail.com>2020-09-07 11:41:37 -0500
committerThomas Vigouroux <tomvig38@gmail.com>2020-09-08 15:07:23 +0200
commit7b972d581cbdffb2031a3cf46de7fe4ba658dea7 (patch)
treecd834258aa40b93987c9bacd2c0ec2d93ce6a55e
parentfix using highlight query extension for every query type (diff)
downloadnvim-treesitter-7b972d581cbdffb2031a3cf46de7fe4ba658dea7.tar
nvim-treesitter-7b972d581cbdffb2031a3cf46de7fe4ba658dea7.tar.gz
nvim-treesitter-7b972d581cbdffb2031a3cf46de7fe4ba658dea7.tar.bz2
nvim-treesitter-7b972d581cbdffb2031a3cf46de7fe4ba658dea7.tar.lz
nvim-treesitter-7b972d581cbdffb2031a3cf46de7fe4ba658dea7.tar.xz
nvim-treesitter-7b972d581cbdffb2031a3cf46de7fe4ba658dea7.tar.zst
nvim-treesitter-7b972d581cbdffb2031a3cf46de7fe4ba658dea7.zip
Fold: update docs
Document foldnestmax.
-rw-r--r--README.md6
-rw-r--r--doc/nvim-treesitter.txt3
2 files changed, 7 insertions, 2 deletions
diff --git a/README.md b/README.md
index d5153ef31..3f3f7870f 100644
--- a/README.md
+++ b/README.md
@@ -299,14 +299,16 @@ EOF
# Extra features
-- Syntax based code folding
+## Syntax based code folding
```vim
set foldmethod=expr
set foldexpr=nvim_treesitter#foldexpr()
```
-- Statusline indicator
+This will respect your `foldnestmax` setting.
+
+## Statusline indicator
```vim
echo nvim_treesitter#statusline(90) " 90 can be any length
diff --git a/doc/nvim-treesitter.txt b/doc/nvim-treesitter.txt
index 5afcd9069..e14a2ac15 100644
--- a/doc/nvim-treesitter.txt
+++ b/doc/nvim-treesitter.txt
@@ -551,6 +551,9 @@ To use it: >
set foldmethod=expr
set foldexpr=nvim_treesitter#foldexr()
<
+
+This will respect your 'foldnestmax' setting.
+
Note: This is highly experimental, and folding can break on some types of
edits. If you encounter such breakage, hiting `zx` should fix folding.
In any case, feel free to open an issue with the reproducing steps.