aboutsummaryrefslogtreecommitdiffstats
path: root/src/treesit.c
diff options
context:
space:
mode:
authorEli Zaretskii2025-02-28 09:12:05 +0200
committerEli Zaretskii2025-02-28 09:12:05 +0200
commit6ed119d3052ffebd20450ec0c7fb3abf863b3a49 (patch)
tree01b6fdb5cdfeecebda3004861bb27d76a2f57948 /src/treesit.c
parentbecdfb11a5b13bc773729236763e99e513806451 (diff)
downloademacs-6ed119d3052ffebd20450ec0c7fb3abf863b3a49.tar.gz
emacs-6ed119d3052ffebd20450ec0c7fb3abf863b3a49.zip
; Fix documentation of recent treesit changes
* src/treesit.c (Ftreesit_query_capture) (Ftreesit_parser_embed_level, Ftreesit_parser_set_embed_level) (Ftreesit_parser_set_parent_node): * lisp/treesit.el (treesit-query-range) (treesit-query-range-by-language, treesit-range-settings) (treesit-range-rules, treesit--parser-at-level) (treesit--update-ranges-non-local, treesit--update-ranges-local) (treesit--update-range-1): Fix wording and typos in doc strings. * doc/lispref/parsing.texi (Pattern Matching): Fix wording.
Diffstat (limited to 'src/treesit.c')
-rw-r--r--src/treesit.c17
1 files changed, 10 insertions, 7 deletions
diff --git a/src/treesit.c b/src/treesit.c
index c8af17a5b8b..20c3626732a 100644
--- a/src/treesit.c
+++ b/src/treesit.c
@@ -1827,8 +1827,8 @@ DEFUN ("treesit-parser-embed-level",
1827 1827
1828The embed level can be either nil or a non-negative integer. A value of 1828The embed level can be either nil or a non-negative integer. A value of
1829nil means the parser isn't part of the embedded parser tree. The 1829nil means the parser isn't part of the embedded parser tree. The
1830primary parser has embed level 0, from it, each layer of embedded parser 1830primary parser has embed level 0, and each additional layer of parser
1831has +1 embed level. */) 1831embedding increments the embed level by 1. */)
1832 (Lisp_Object parser) 1832 (Lisp_Object parser)
1833{ 1833{
1834 treesit_check_parser (parser); 1834 treesit_check_parser (parser);
@@ -1839,7 +1839,9 @@ has +1 embed level. */)
1839DEFUN ("treesit-parser-set-embed-level", 1839DEFUN ("treesit-parser-set-embed-level",
1840 Ftreesit_parser_set_embed_level, Streesit_parser_set_embed_level, 1840 Ftreesit_parser_set_embed_level, Streesit_parser_set_embed_level,
1841 2, 2, 0, 1841 2, 2, 0,
1842 doc: /* Set the embed level for PARSER to LEVEL. */) 1842 doc: /* Set the embed level for PARSER to LEVEL.
1843LEVEL can be nil, for a parser that is not part of an embedded parser
1844tree; otherwise it must be a non-negative integer. */)
1843 (Lisp_Object parser, Lisp_Object level) 1845 (Lisp_Object parser, Lisp_Object level)
1844{ 1846{
1845 treesit_check_parser (parser); 1847 treesit_check_parser (parser);
@@ -1859,7 +1861,7 @@ DEFUN ("treesit-parser-parent-node",
1859 1, 1, 0, 1861 1, 1, 0,
1860 doc: /* Return PARSER's parent node, if one exists. 1862 doc: /* Return PARSER's parent node, if one exists.
1861 1863
1862Only embeded local parser can have parent node. When Emacs uses a node 1864Only embeded local parsers can have parent node. When Emacs uses a node
1863in the host parser to create this local parser, that node is considered 1865in the host parser to create this local parser, that node is considered
1864the parent node of the local parser. */) 1866the parent node of the local parser. */)
1865 (Lisp_Object parser) 1867 (Lisp_Object parser)
@@ -1871,7 +1873,7 @@ the parent node of the local parser. */)
1871DEFUN ("treesit-parser-set-parent-node", 1873DEFUN ("treesit-parser-set-parent-node",
1872 Ftreesit_parser_set_parent_node, Streesit_parser_set_parent_node, 1874 Ftreesit_parser_set_parent_node, Streesit_parser_set_parent_node,
1873 2, 2, 0, 1875 2, 2, 0,
1874 doc: /* Return PARSER's parent node to NODE. */) 1876 doc: /* Make NODE be the parent node of PARSER. */)
1875 (Lisp_Object parser, Lisp_Object node) 1877 (Lisp_Object parser, Lisp_Object node)
1876{ 1878{
1877 treesit_check_parser (parser); 1879 treesit_check_parser (parser);
@@ -3289,8 +3291,9 @@ in which the query is executed. Any matching node whose span overlaps
3289with the region between BEG and END are captured, it doesn't have to 3291with the region between BEG and END are captured, it doesn't have to
3290be completely in the region. 3292be completely in the region.
3291 3293
3292If GROUPED is non-nil, group captures into matches and return a list of 3294If GROUPED is non-nil, ther function groups the returned list of
3293MATCH, where each MATH is a list of (CAPTURE_NAME . NODE). 3295captures into matches and return a list of MATCH, where each MATCH is
3296a list of the form (CAPTURE_NAME . NODE).
3294 3297
3295If NODE-ONLY is non-nil, return nodes only, and don't include 3298If NODE-ONLY is non-nil, return nodes only, and don't include
3296CAPTURE_NAME. 3299CAPTURE_NAME.