mirrors/snacks.nvim
1
0
Fork 0
mirror of https://github.com/folke/snacks.nvim synced 2025-08-04 18:58:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

chore(build): auto-generate docs

Browse source
This commit is contained in:
folke 2024-11-18 07:57:46 +00:00 • committed by github-actions[bot]
parent 73b1e20d38
commit 063525196a
3 changed files with 24 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docs/debug.md
View file

@ -27,6 +27,12 @@ What this does:
<!-- docgen -->
## 📚 Types
```lua
---@alias snacks.debug.Trace {name: string, time: number, [number]:snacks.debug.Trace}
```
## 📦 Module
### `Snacks.debug()`
@ -81,3 +87,17 @@ Very simple function to profile a lua function.
---@param opts? {count?: number, flush?: boolean}
Snacks.debug.profile(fn, opts)
```
### `Snacks.debug.stats()`
```lua
---@param opts? {min?: number}
Snacks.debug.stats(opts)
```
### `Snacks.debug.trace()`
```lua
---@param name string?
Snacks.debug.trace(name)
```