ci: docgen

docs/bufdelete.md

@@ -6,10 +6,16 @@
 
 ```lua
 ---@class snacks.bufdelete
----@overload fun(buf?: number)
 Snacks.bufdelete = {}
 ```
 
+### `Snacks.bufdelete()`
+
+```lua
+---@type fun(buf?: number)
+Snacks.bufdelete()
+```
+
 ### `Snacks.bufdelete.delete()`
 
 ```lua

docs/debug.md

@@ -6,10 +6,16 @@
 
 ```lua
 ---@class snacks.debug
----@overload fun(msg: string|string[], opts?: snacks.notify.Opts)
 Snacks.debug = {}
 ```
 
+### `Snacks.debug()`
+
+```lua
+---@type fun(msg: string|string[], opts?: snacks.notify.Opts)
+Snacks.debug()
+```
+
 ### `Snacks.debug.backtrace()`
 
 ```lua

docs/float.md

@@ -1,112 +0,0 @@
-# 🍿 float
-
-<!-- docgen -->
-
-## ⚙️ Config
-
-```lua
----@class snacks.float.Config
----@field position? "float"|"bottom"|"top"|"left"|"right"
----@field buf? number
----@field file? string
----@field enter? boolean
----@field backdrop? number|false
----@field win? vim.api.keyset.win_config
----@field wo? vim.wo
----@field bo? vim.bo
----@field keys? table<string, false|string|fun(self: snacks.float)|snacks.float.Keys>
----@field on_buf? fun(self: snacks.float)
----@field on_win? fun(self: snacks.float)
-{
-  position = "float",
-  win = {
-    relative = "editor",
-    style = "minimal",
-  },
-  wo = {
-    winhighlight = "EndOfBuffer:NormalFloat,Normal:NormalFloat,NormalNC:NormalFloat",
-  },
-  bo = {},
-  keys = {
-    q = "close",
-  },
-}
-```
-
-## 📦 Module
-
-```lua
----@class snacks.float.Keys: vim.api.keyset.keymap
----@field [1]? string
----@field [2]? string|fun(self: snacks.float): any
----@field mode? string|string[]
-```
-
-```lua
----@class snacks.float
----@field id number
----@field buf? number
----@field win? number
----@field opts snacks.float.Config
----@field augroup? number
----@field backdrop? snacks.float
----@overload fun(opts? :snacks.float.Config): snacks.float
-Snacks.float = {}
-```
-
-### `Snacks.float.new()`
-
-```lua
----@param opts? snacks.float.Config
----@return snacks.float
-Snacks.float.new(opts)
-```
-
-### `float:buf_valid()`
-
-```lua
-float:buf_valid()
-```
-
-### `float:close()`
-
-```lua
----@param opts? { buf: boolean }
-float:close(opts)
-```
-
-### `float:hide()`
-
-```lua
-float:hide()
-```
-
-### `float:is_floating()`
-
-```lua
-float:is_floating()
-```
-
-### `float:show()`
-
-```lua
-float:show()
-```
-
-### `float:toggle()`
-
-```lua
-float:toggle()
-```
-
-### `float:valid()`
-
-```lua
-float:valid()
-```
-
-### `float:win_valid()`
-
-```lua
-float:win_valid()
-```

docs/gitbrowse.md

@@ -36,10 +36,16 @@
 
 ```lua
 ---@class snacks.gitbrowse
----@overload fun(opts?: snacks.gitbrowse.Config)
 Snacks.gitbrowse = {}
 ```
 
+### `Snacks.gitbrowse()`
+
+```lua
+---@type fun(opts?: snacks.gitbrowse.Config)
+Snacks.gitbrowse()
+```
+
 ### `Snacks.gitbrowse.get_url()`
 
 ```lua

docs/init.md

@@ -12,7 +12,7 @@
 ---@field statuscolumn snacks.statuscolumn
 ---@field words snacks.words
 ---@field rename snacks.rename
----@field float snacks.float
+---@field win snacks.win
 ---@field terminal snacks.terminal
 ---@field lazygit snacks.lazygit
 ---@field git snacks.git

docs/lazygit.md

@@ -47,10 +47,16 @@
 
 ```lua
 ---@class snacks.lazygit
----@overload fun(opts?: snacks.lazygit.Config): snacks.float
 Snacks.lazygit = {}
 ```
 
+### `Snacks.lazygit()`
+
+```lua
+---@type fun(opts?: snacks.lazygit.Config): snacks.win
+Snacks.lazygit()
+```
+
 ### `Snacks.lazygit.log()`
 
 ```lua

docs/notify.md

@@ -10,10 +10,16 @@
 
 ```lua
 ---@class snacks.notify
----@overload fun(msg: string|string[], opts?: snacks.notify.Opts)
 Snacks.notify = {}
 ```
 
+### `Snacks.notify()`
+
+```lua
+---@type fun(msg: string|string[], opts?: snacks.notify.Opts)
+Snacks.notify()
+```
+
 ### `Snacks.notify.error()`
 
 ```lua

docs/rename.md

@@ -6,10 +6,16 @@
 
 ```lua
 ---@class snacks.rename
----@overload fun()
 Snacks.rename = {}
 ```
 
+### `Snacks.rename()`
+
+```lua
+---@type fun()
+Snacks.rename()
+```
+
 ### `Snacks.rename.on_rename()`
 
 ```lua

docs/statuscolumn.md

@@ -29,10 +29,16 @@
 
 ```lua
 ---@class snacks.statuscolumn
----@overload fun(): string
 Snacks.statuscolumn = {}
 ```
 
+### `Snacks.statuscolumn()`
+
+```lua
+---@type fun(): string
+Snacks.statuscolumn()
+```
+
 ### `Snacks.statuscolumn.buf_signs()`
 
 Returns a list of regular and extmark signs sorted by priority (low to high)

docs/terminal.md

@@ -8,7 +8,7 @@
 ---@class snacks.terminal.Config
 ---@field cwd? string
 ---@field env? table<string, string>
----@field float? snacks.float.Config
+---@field float? snacks.win.Config
 ---@field interactive? boolean
 ---@field override? fun(cmd?: string|string[], opts?: snacks.terminal.Config) Use this to use a different terminal implementation
 {
@@ -49,13 +49,19 @@
 ## 📦 Module
 
 ```lua
----@class snacks.terminal: snacks.float
+---@class snacks.terminal: snacks.win
 ---@field cmd? string | string[]
 ---@field opts snacks.terminal.Config
----@overload fun(cmd?: string|string[], opts?: snacks.terminal.Config): snacks.terminal
 Snacks.terminal = {}
 ```
 
+### `Snacks.terminal()`
+
+```lua
+---@type fun(cmd?: string|string[], opts?: snacks.terminal.Config): snacks.terminal
+Snacks.terminal()
+```
+
 ### `Snacks.terminal.open()`
 
 ```lua

docs/win.md

@@ -0,0 +1,118 @@
+# 🍿 win
+
+<!-- docgen -->
+
+## ⚙️ Config
+
+```lua
+---@class snacks.win.Config
+---@field position? "float"|"bottom"|"top"|"left"|"right"
+---@field buf? number
+---@field file? string
+---@field enter? boolean
+---@field backdrop? number|false
+---@field win? vim.api.keyset.win_config
+---@field wo? vim.wo
+---@field bo? vim.bo
+---@field keys? table<string, false|string|fun(self: snacks.win)|snacks.win.Keys>
+---@field on_buf? fun(self: snacks.win)
+---@field on_win? fun(self: snacks.win)
+{
+  position = "float",
+  win = {
+    relative = "editor",
+    style = "minimal",
+  },
+  wo = {
+    winhighlight = "EndOfBuffer:NormalFloat,Normal:NormalFloat,NormalNC:NormalFloat",
+  },
+  bo = {},
+  keys = {
+    q = "close",
+  },
+}
+```
+
+## 📦 Module
+
+```lua
+---@class snacks.win.Keys: vim.api.keyset.keymap
+---@field [1]? string
+---@field [2]? string|fun(self: snacks.win): any
+---@field mode? string|string[]
+```
+
+```lua
+---@class snacks.win
+---@field id number
+---@field buf? number
+---@field win? number
+---@field opts snacks.win.Config
+---@field augroup? number
+---@field backdrop? snacks.win
+Snacks.win = {}
+```
+
+### `Snacks.win()`
+
+```lua
+---@type fun(opts? :snacks.win.Config): snacks.win
+Snacks.win()
+```
+
+### `Snacks.win.new()`
+
+```lua
+---@param opts? snacks.win.Config
+---@return snacks.win
+Snacks.win.new(opts)
+```
+
+### `win:buf_valid()`
+
+```lua
+win:buf_valid()
+```
+
+### `win:close()`
+
+```lua
+---@param opts? { buf: boolean }
+win:close(opts)
+```
+
+### `win:hide()`
+
+```lua
+win:hide()
+```
+
+### `win:is_floating()`
+
+```lua
+win:is_floating()
+```
+
+### `win:show()`
+
+```lua
+win:show()
+```
+
+### `win:toggle()`
+
+```lua
+win:toggle()
+```
+
+### `win:valid()`
+
+```lua
+win:valid()
+```
+
+### `win:win_valid()`
+
+```lua
+win:win_valid()
+```