docs(treesitter): number → integer (#22513)

This commit is contained in:
Jaehwang Jung
2023-03-04 22:04:05 +09:00
committed by GitHub
parent 6cab36e5b7
commit 128b82103b
3 changed files with 22 additions and 22 deletions

View File

@@ -1,7 +1,7 @@
local api = vim.api
---@class TSPlayground
---@field ns number API namespace
---@field ns integer API namespace
---@field opts table Options table with the following keys:
--- - anon (boolean): If true, display anonymous nodes
--- - lang (boolean): If true, display the language alongside each node
@@ -10,14 +10,14 @@ local api = vim.api
local TSPlayground = {}
---
---@class Node
---@field id number Node id
---@field id integer Node id
---@field text string Node text
---@field named boolean True if this is a named (non-anonymous) node
---@field depth number Depth of the node within the tree
---@field lnum number Beginning line number of this node in the source buffer
---@field col number Beginning column number of this node in the source buffer
---@field end_lnum number Final line number of this node in the source buffer
---@field end_col number Final column number of this node in the source buffer
---@field depth integer Depth of the node within the tree
---@field lnum integer Beginning line number of this node in the source buffer
---@field col integer Beginning column number of this node in the source buffer
---@field end_lnum integer Final line number of this node in the source buffer
---@field end_col integer Final column number of this node in the source buffer
---@field lang string Source language of this node
---@field root TSNode
@@ -34,7 +34,7 @@ local TSPlayground = {}
--- table maps nodes in the primary tree to root nodes of injected trees.
---
---@param node TSNode Starting node to begin traversal |tsnode|
---@param depth number Current recursion depth
---@param depth integer Current recursion depth
---@param lang string Language of the tree currently being traversed
---@param injections table<integer,Node> Mapping of node ids to root nodes of injected language trees (see
--- explanation above)
@@ -153,7 +153,7 @@ end
--- Write the contents of this Playground into {bufnr}.
---
---@param bufnr number Buffer number to write into.
---@param bufnr integer Buffer number to write into.
---@private
function TSPlayground:draw(bufnr)
vim.bo[bufnr].modifiable = true
@@ -194,7 +194,7 @@ end
---
--- The node number is dependent on whether or not anonymous nodes are displayed.
---
---@param i number Node number to get
---@param i integer Node number to get
---@return Node
---@private
function TSPlayground:get(i)
@@ -206,7 +206,7 @@ end
---
---@return (fun(): integer, Node) Iterator over all nodes in this Playground
---@return table
---@return number
---@return integer
---@private
function TSPlayground:iter()
return ipairs(self.opts.anon and self.nodes or self.named)