aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorThomas Vigouroux <tomvig38@gmail.com>2020-05-25 10:29:18 +0200
committerThomas Vigouroux <tomvig38@gmail.com>2020-05-25 11:19:38 +0200
commitc035fb9f5d2a5d9809cd11f83df6593a2a25ee8f (patch)
tree436aed274a7ba512a3cec8a5e1207d788a59e7f6 /doc
parentfeat: add syntax-based folding (diff)
downloadnvim-treesitter-c035fb9f5d2a5d9809cd11f83df6593a2a25ee8f.tar
nvim-treesitter-c035fb9f5d2a5d9809cd11f83df6593a2a25ee8f.tar.gz
nvim-treesitter-c035fb9f5d2a5d9809cd11f83df6593a2a25ee8f.tar.bz2
nvim-treesitter-c035fb9f5d2a5d9809cd11f83df6593a2a25ee8f.tar.lz
nvim-treesitter-c035fb9f5d2a5d9809cd11f83df6593a2a25ee8f.tar.xz
nvim-treesitter-c035fb9f5d2a5d9809cd11f83df6593a2a25ee8f.tar.zst
nvim-treesitter-c035fb9f5d2a5d9809cd11f83df6593a2a25ee8f.zip
docs: document folding
Diffstat (limited to 'doc')
-rw-r--r--doc/nvim-treesitter.txt12
-rw-r--r--doc/tags1
2 files changed, 13 insertions, 0 deletions
diff --git a/doc/nvim-treesitter.txt b/doc/nvim-treesitter.txt
index 564d9ee88..85bcbddd9 100644
--- a/doc/nvim-treesitter.txt
+++ b/doc/nvim-treesitter.txt
@@ -165,4 +165,16 @@ could be used as a statusline indicator.
Note: The `size` argument is optionnal. When specified, the string will not be
longer than `size`.
+|nvim_treesitter#foldexpr()|
+ *nvim_treesitter#foldexpr()*
+
+Functions to be used to determine the fold level at a given line number.
+To use it: >
+ set foldmethod=expr
+ set foldexpr=nvim_treesitter#foldexr()
+<
+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.
+
vim:tw=78:ts=8:noet:ft=help:norl:
diff --git a/doc/tags b/doc/tags
index e58f0d658..0a12b18d5 100644
--- a/doc/tags
+++ b/doc/tags
@@ -11,6 +11,7 @@ nvim-treesitter-commands nvim-treesitter.txt /*nvim-treesitter-commands*
nvim-treesitter-functions nvim-treesitter.txt /*nvim-treesitter-functions*
nvim-treesitter-intro nvim-treesitter.txt /*nvim-treesitter-intro*
nvim-treesitter-quickstart nvim-treesitter.txt /*nvim-treesitter-quickstart*
+nvim_treesitter#foldexpr() nvim-treesitter.txt /*nvim_treesitter#foldexpr()*
nvim_treesitter#statusline() nvim-treesitter.txt /*nvim_treesitter#statusline()*
ts_api.containing_scope nvim-treesitter.txt /*ts_api.containing_scope*
ts_api.get_named_children nvim-treesitter.txt /*ts_api.get_named_children*