From ab2a0f325b906574698933824b381ed65c7482a3 Mon Sep 17 00:00:00 2001
From: Gokul Soumya
Date: Fri, 11 Feb 2022 09:01:52 +0530
Subject: Add object.movement for tree-sitter navigation

---
 book/src/guides/textobject.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

(limited to 'book/src/guides/textobject.md')

diff --git a/book/src/guides/textobject.md b/book/src/guides/textobject.md
index dd726b7c..7200a514 100644
--- a/book/src/guides/textobject.md
+++ b/book/src/guides/textobject.md
@@ -24,7 +24,22 @@ The following [captures][tree-sitter-captures] are recognized:
 
 [Example query files][textobject-examples] can be found in the helix GitHub repository.
 
+## Queries for Textobject Based Navigation
+
+[Tree-sitter based navigation][textobjects-nav] is done using captures in the
+following order:
+
+- `object.movement`
+- `object.around`
+- `object.inside`
+
+For example if a `function.around` capture has been already defined for a language
+in it's `textobjects.scm` file, function navigation should also work automatically.
+`function.movement` should be defined only if the node captured by `function.around`
+doesn't make sense in a navigation context.
+
 [textobjects]: ../usage.md#textobjects
+[textobjects-nav]: ../usage.md#tree-sitter-textobject-based-navigation
 [tree-sitter-queries]: https://tree-sitter.github.io/tree-sitter/using-parsers#query-syntax
 [tree-sitter-captures]: https://tree-sitter.github.io/tree-sitter/using-parsers#capturing-nodes
 [textobject-examples]: https://github.com/search?q=repo%3Ahelix-editor%2Fhelix+filename%3Atextobjects.scm&type=Code&ref=advsearch&l=&l=
-- 
cgit v1.2.3-70-g09d2