diff options
author | Juri Linkov <juri@linkov.net> | 2023-01-04 09:57:06 +0200 |
---|---|---|
committer | Juri Linkov <juri@linkov.net> | 2023-01-04 09:57:06 +0200 |
commit | 6b5831c6964873025dabfb924bd23dfc72138c5d (patch) | |
tree | df25a9340f8342d0e85eba0fdd0bd6c514275051 /admin/notes/tree-sitter | |
parent | 651927ac3916f601e3ea29281572621044e08fb7 (diff) | |
download | emacs-6b5831c6964873025dabfb924bd23dfc72138c5d.tar.gz emacs-6b5831c6964873025dabfb924bd23dfc72138c5d.tar.bz2 emacs-6b5831c6964873025dabfb924bd23dfc72138c5d.zip |
Tree-sitter doc fixes (bug#60524)
* doc/lispref/modes.texi (Parser-based Font Lock):
Replace :lang with :language.
* doc/lispref/parsing.texi (Language Grammar): Replace
treesit-load-suffixes with dynamic-library-suffixes.
(Retrieving Nodes): Fix function names.
(Tree-sitter Major Modes): Fix treesit-ready-p args.
Fix pxref to Parser-based Indentation.
(Tree-sitter C API): Fix function names.
* lisp/treesit.el (treesit--simple-indent-eval): Remove cond BODY
duplicated from CONDITION.
(treesit)<define-short-documentation-group>: Fix function names.
Diffstat (limited to 'admin/notes/tree-sitter')
6 files changed, 15 insertions, 15 deletions
diff --git a/admin/notes/tree-sitter/html-manual/Accessing-Node.html b/admin/notes/tree-sitter/html-manual/Accessing-Node.html index 9e7a4b68299..afbbdaa11b5 100644 --- a/admin/notes/tree-sitter/html-manual/Accessing-Node.html +++ b/admin/notes/tree-sitter/html-manual/Accessing-Node.html @@ -187,7 +187,7 @@ of <var>node</var> as a child of its parent. </p></dd></dl> <dl class="def"> -<dt id="index-treesit_002dchild_002dcount"><span class="category">Function: </span><span><strong>treesit-child-count</strong> <em>node &optional named</em><a href='#index-treesit_002dchild_002dcount' class='copiable-anchor'> ¶</a></span></dt> +<dt id="index-treesit_002dchild_002dcount"><span class="category">Function: </span><span><strong>treesit-node-child-count</strong> <em>node &optional named</em><a href='#index-treesit_002dchild_002dcount' class='copiable-anchor'> ¶</a></span></dt> <dd><p>This function finds the number of children of <var>node</var>. If <var>named</var> is non-nil, it only counts named child (see <a href="Language-Definitions.html#tree_002dsitter-named-node">named node</a>). </p></dd></dl> diff --git a/admin/notes/tree-sitter/html-manual/Language-Definitions.html b/admin/notes/tree-sitter/html-manual/Language-Definitions.html index 6c17e8c3344..9b1e0021272 100644 --- a/admin/notes/tree-sitter/html-manual/Language-Definitions.html +++ b/admin/notes/tree-sitter/html-manual/Language-Definitions.html @@ -94,7 +94,7 @@ specified by <code>user-emacs-directory</code> (see <a href="Init-File.html">The </li></ul> <p>In each of these directories, Emacs looks for a file with file-name -extensions specified by the variable <code>treesit-load-suffixes</code>. +extensions specified by the variable <code>dynamic-library-suffixes</code>. </p> <p>If Emacs cannot find the library or has problems loading it, Emacs signals the <code>treesit-load-language-error</code> error. The data of diff --git a/admin/notes/tree-sitter/html-manual/Parser_002dbased-Font-Lock.html b/admin/notes/tree-sitter/html-manual/Parser_002dbased-Font-Lock.html index 670f235bd20..a3fe6622162 100644 --- a/admin/notes/tree-sitter/html-manual/Parser_002dbased-Font-Lock.html +++ b/admin/notes/tree-sitter/html-manual/Parser_002dbased-Font-Lock.html @@ -134,7 +134,7 @@ example: tree-sitter query in either the string, s-expression or compiled form. </p> <p>For each <var>query</var>, the <var>:keyword</var>/<var>value</var> pairs that -precede it add meta information to it. The <code>:lang</code> keyword +precede it add meta information to it. The <code>:language</code> keyword declares <var>query</var>’s language. The <code>:feature</code> keyword sets the feature name of <var>query</var>. Users can control which features are enabled with <code>font-lock-maximum-decoration</code> and diff --git a/admin/notes/tree-sitter/html-manual/Retrieving-Node.html b/admin/notes/tree-sitter/html-manual/Retrieving-Node.html index 58e87e8df7f..16eeb0b1091 100644 --- a/admin/notes/tree-sitter/html-manual/Retrieving-Node.html +++ b/admin/notes/tree-sitter/html-manual/Retrieving-Node.html @@ -201,13 +201,13 @@ is the string text. </p></dd></dl> <dl class="def"> -<dt id="index-treesit_002dnext_002dsibling"><span class="category">Function: </span><span><strong>treesit-next-sibling</strong> <em>node &optional named</em><a href='#index-treesit_002dnext_002dsibling' class='copiable-anchor'> ¶</a></span></dt> +<dt id="index-treesit_002dnext_002dsibling"><span class="category">Function: </span><span><strong>treesit-node-next-sibling</strong> <em>node &optional named</em><a href='#index-treesit_002dnext_002dsibling' class='copiable-anchor'> ¶</a></span></dt> <dd><p>This function finds the next sibling of <var>node</var>. If <var>named</var> is non-<code>nil</code>, it finds the next named sibling. </p></dd></dl> <dl class="def"> -<dt id="index-treesit_002dprev_002dsibling"><span class="category">Function: </span><span><strong>treesit-prev-sibling</strong> <em>node &optional named</em><a href='#index-treesit_002dprev_002dsibling' class='copiable-anchor'> ¶</a></span></dt> +<dt id="index-treesit_002dprev_002dsibling"><span class="category">Function: </span><span><strong>treesit-node-prev-sibling</strong> <em>node &optional named</em><a href='#index-treesit_002dprev_002dsibling' class='copiable-anchor'> ¶</a></span></dt> <dd><p>This function finds the previous sibling of <var>node</var>. If <var>named</var> is non-<code>nil</code>, it finds the previous named sibling. </p></dd></dl> @@ -221,13 +221,13 @@ assign <em>field names</em> to child nodes (see <a href="Language-Definitions.ht could have a <code>declarator</code> node and a <code>body</code> node. </p> <dl class="def"> -<dt id="index-treesit_002dchild_002dby_002dfield_002dname"><span class="category">Function: </span><span><strong>treesit-child-by-field-name</strong> <em>node field-name</em><a href='#index-treesit_002dchild_002dby_002dfield_002dname' class='copiable-anchor'> ¶</a></span></dt> +<dt id="index-treesit_002dchild_002dby_002dfield_002dname"><span class="category">Function: </span><span><strong>treesit-node-child-by-field-name</strong> <em>node field-name</em><a href='#index-treesit_002dchild_002dby_002dfield_002dname' class='copiable-anchor'> ¶</a></span></dt> <dd><p>This function finds the child of <var>node</var> whose field name is <var>field-name</var>, a string. </p> <div class="example"> <pre class="example">;; Get the child that has "body" as its field name. -(treesit-child-by-field-name node "body") +(treesit-node-child-by-field-name node "body") ⇒ #<treesit-node (compound_statement) in 45-89> </pre></div> </dd></dl> @@ -237,7 +237,7 @@ could have a <code>declarator</code> node and a <code>body</code> node. <span id="index-syntax-tree-nodes_002c-by-position"></span> <dl class="def"> -<dt id="index-treesit_002dfirst_002dchild_002dfor_002dpos"><span class="category">Function: </span><span><strong>treesit-first-child-for-pos</strong> <em>node pos &optional named</em><a href='#index-treesit_002dfirst_002dchild_002dfor_002dpos' class='copiable-anchor'> ¶</a></span></dt> +<dt id="index-treesit_002dfirst_002dchild_002dfor_002dpos"><span class="category">Function: </span><span><strong>treesit-node-first-child-for-pos</strong> <em>node pos &optional named</em><a href='#index-treesit_002dfirst_002dchild_002dfor_002dpos' class='copiable-anchor'> ¶</a></span></dt> <dd><p>This function finds the first child of <var>node</var> that extends beyond buffer position <var>pos</var>. “Extends beyond” means the end of the child node is greater or equal to <var>pos</var>. This function only looks diff --git a/admin/notes/tree-sitter/html-manual/Tree_002dsitter-C-API.html b/admin/notes/tree-sitter/html-manual/Tree_002dsitter-C-API.html index 0c827b3e755..1d992b828ea 100644 --- a/admin/notes/tree-sitter/html-manual/Tree_002dsitter-C-API.html +++ b/admin/notes/tree-sitter/html-manual/Tree_002dsitter-C-API.html @@ -142,12 +142,12 @@ ts_node_named_child treesit-node-child ts_node_named_child_count treesit-node-child-count ts_node_child_by_field_name treesit-node-by-field-name ts_node_child_by_field_id -ts_node_next_sibling treesit-next-sibling -ts_node_prev_sibling treesit-prev-sibling -ts_node_next_named_sibling treesit-next-sibling -ts_node_prev_named_sibling treesit-prev-sibling -ts_node_first_child_for_byte treesit-first-child-for-pos -ts_node_first_named_child_for_byte treesit-first-child-for-pos +ts_node_next_sibling treesit-node-next-sibling +ts_node_prev_sibling treesit-node-prev-sibling +ts_node_next_named_sibling treesit-node-next-sibling +ts_node_prev_named_sibling treesit-node-prev-sibling +ts_node_first_child_for_byte treesit-node-first-child-for-pos +ts_node_first_named_child_for_byte treesit-node-first-child-for-pos ts_node_descendant_for_byte_range treesit-descendant-for-range ts_node_descendant_for_point_range ts_node_named_descendant_for_byte_range treesit-descendant-for-range diff --git a/admin/notes/tree-sitter/starter-guide b/admin/notes/tree-sitter/starter-guide index a6a4c647f23..606f7891dfa 100644 --- a/admin/notes/tree-sitter/starter-guide +++ b/admin/notes/tree-sitter/starter-guide @@ -238,7 +238,7 @@ Concretely, something like this: ... (cond ;; Tree-sitter. - ((treesit-ready-p 'python-mode 'python) + ((treesit-ready-p 'python) (treesit-parser-create 'python) (setq-local treesit-font-lock-settings python--treesit-settings) (setq-local treesit-font-lock-feature-list |