docs: treesitter.txt - fix overflowing lines, document minimum_language_version (#17286)

2 files changed, 17 insertions, 15 deletions

diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index 85fd5cd8e0..b83df65151 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -76,8 +76,8 @@ function LanguageTree:lang()
 end
 
 --- Determines whether this tree is valid.
---- If the tree is invalid, `parse()` must be called
---- to get the updated tree.
+--- If the tree is invalid, call `parse()`.
+--- This will return the updated tree.
 function LanguageTree:is_valid()
   return self._valid
 end
@@ -234,7 +234,9 @@ end
 --- Destroys this language tree and all its children.
 ---
 --- Any cleanup logic should be performed here.
---- Note, this DOES NOT remove this tree from a parent.
+---
+--- Note:
+--- This DOES NOT remove this tree from a parent. Instead,
 --- `remove_child` must be called on the parent to remove it.
 function LanguageTree:destroy()
   -- Cleanup here
@@ -448,14 +450,14 @@ function LanguageTree:_on_detach(...)
   self:_do_callback('detach', ...)
 end
 
---- Registers callbacks for the parser
----@param cbs An `nvim_buf_attach`-like table argument with the following keys :
----  `on_bytes` : see `nvim_buf_attach`, but this will be called _after_ the parsers callback.
----  `on_changedtree` : a callback that will be called every time the tree has syntactical changes.
----      it will only be passed one argument, that is a table of the ranges (as node ranges) that
----      changed.
----  `on_child_added` : emitted when a child is added to the tree.
----  `on_child_removed` : emitted when a child is removed from the tree.
+--- Registers callbacks for the parser.
+---@param cbs table An |nvim_buf_attach()|-like table argument with the following keys :
+---           - `on_bytes` : see |nvim_buf_attach()|, but this will be called _after_ the parsers callback.
+---           - `on_changedtree` : a callback that will be called every time the tree has syntactical changes.
+---              It will only be passed one argument, which is a table of the ranges (as node ranges) that
+---              changed.
+---           - `on_child_added` : emitted when a child is added to the tree.
+---           - `on_child_removed` : emitted when a child is removed from the tree.
 function LanguageTree:register_cbs(cbs)
   if not cbs then return end
 
@@ -493,7 +495,7 @@ local function tree_contains(tree, range)
   return false
 end
 
---- Determines whether @param range is contained in this language tree
+--- Determines whether {range} is contained in this language tree
 ---
 --- This goes down the tree to recursively check children.
 ---
@@ -508,7 +510,7 @@ function LanguageTree:contains(range)
   return false
 end
 
---- Gets the appropriate language that contains @param range
+--- Gets the appropriate language that contains {range}
 ---
 ---@param range A text range, see |LanguageTree:contains|
 function LanguageTree:language_for_range(range)
diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index 14940332d6..8383551b5f 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -146,13 +146,13 @@ local query_cache = setmetatable({}, {
 })
 
 --- Parse {query} as a string. (If the query is in a file, the caller
----       should read the contents into a string before calling).
+--- should read the contents into a string before calling).
 ---
 --- Returns a `Query` (see |lua-treesitter-query|) object which can be used to
 --- search nodes in the syntax tree for the patterns defined in {query}
 --- using `iter_*` methods below.
 ---
---- Exposes `info` and `captures` with additional information about the {query}.
+--- Exposes `info` and `captures` with additional context about {query}.
 ---   - `captures` contains the list of unique capture names defined in
 ---     {query}.
 ---   -` info.captures` also points to `captures`.