aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorThomas Vigouroux <tomvig38@gmail.com>2020-05-07 08:18:13 +0200
committerThomas Vigouroux <tomvig38@gmail.com>2020-05-07 13:04:53 +0200
commit703ccbec594219e0331c434ee57a0a48c92b280e (patch)
tree15d220a3581f2ceb24ab4fac079bdd5560efe62f /doc
parentfeat: provide a statusline indicator (diff)
downloadnvim-treesitter-703ccbec594219e0331c434ee57a0a48c92b280e.tar
nvim-treesitter-703ccbec594219e0331c434ee57a0a48c92b280e.tar.gz
nvim-treesitter-703ccbec594219e0331c434ee57a0a48c92b280e.tar.bz2
nvim-treesitter-703ccbec594219e0331c434ee57a0a48c92b280e.tar.lz
nvim-treesitter-703ccbec594219e0331c434ee57a0a48c92b280e.tar.xz
nvim-treesitter-703ccbec594219e0331c434ee57a0a48c92b280e.tar.zst
nvim-treesitter-703ccbec594219e0331c434ee57a0a48c92b280e.zip
docs: add statusline indicator informations.
Also document newly added parsers by adding them in the readme.
Diffstat (limited to 'doc')
-rw-r--r--doc/nvim-treesitter.txt13
-rw-r--r--doc/tags2
2 files changed, 14 insertions, 1 deletions
diff --git a/doc/nvim-treesitter.txt b/doc/nvim-treesitter.txt
index ceb834be1..084936bad 100644
--- a/doc/nvim-treesitter.txt
+++ b/doc/nvim-treesitter.txt
@@ -97,5 +97,16 @@ A list of languages can be found at |:TSInstallInfo|
List modules state for the current session.
- vim:tw=78:ts=8:noet:ft=help:norl:
+==============================================================================
+FUNCTIONS~
+ *nvim-treesitter-functions*
+
+|nvim_treesitter#statusline(size)|
+ *nvim_treesitter#statusline()*
+Returns a string describing the current position in the syntax tree. This
+could be used as a statusline indicator.
+Note: The `size` argument is optionnal. When specified, the string will not be
+ longer than `size`.
+
+ vim:tw=78:ts=8:noet:ft=help:norl:
diff --git a/doc/tags b/doc/tags
index 7d69206e3..f712ecf00 100644
--- a/doc/tags
+++ b/doc/tags
@@ -7,5 +7,7 @@
:TSModuleInfo nvim-treesitter.txt /*:TSModuleInfo*
nvim-treesitter nvim-treesitter.txt /*nvim-treesitter*
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#statusline() nvim-treesitter.txt /*nvim_treesitter#statusline()*