docs: improve vim help

folke · Nov 5, 2024 · e6c18f1 · e6c18f1
1 parent cd7c18c
commit e6c18f1
Show file tree

Hide file tree

Showing 26 changed files with 912 additions and 879 deletions.
diff --git a/doc/snacks.nvim-bigfile.txt → doc/snacks-bigfile.txt b/doc/snacks.nvim-bigfile.txt → doc/snacks-bigfile.txt
@@ -1,17 +1,14 @@
-*snacks.nvim-bigfile.txt*       For Neovim       Last change: 2024 November 05
+*snacks-bigfile.txt*          For Neovim         Last change: 2024 November 05
 
 ==============================================================================
-Table of Contents                      *snacks.nvim-bigfile-table-of-contents*
+Table of Contents                           *snacks-bigfile-table-of-contents*
 
-1. bigfile                                       |snacks.nvim-bigfile-bigfile|
-  - Config                                |snacks.nvim-bigfile-bigfile-config|
-  - Module                                |snacks.nvim-bigfile-bigfile-module|
+1. Config                                              |snacks-bigfile-config|
+2. Module                                              |snacks-bigfile-module|
+  - Snacks.bigfile.setup()      |snacks-bigfile-module-snacks.bigfile.setup()|
 
 ==============================================================================
-1. bigfile                                       *snacks.nvim-bigfile-bigfile*
-
-
-CONFIG                                    *snacks.nvim-bigfile-bigfile-config*
+1. Config                                              *snacks-bigfile-config*
 
 >lua
     ---@class snacks.bigfile.Config
@@ -28,15 +25,16 @@ CONFIG                                    *snacks.nvim-bigfile-bigfile-config*
 <
 
 
-MODULE                                    *snacks.nvim-bigfile-bigfile-module*
+==============================================================================
+2. Module                                              *snacks-bigfile-module*
 
 >lua
     ---@class snacks.bigfile
     Snacks.bigfile = {}
 <
 
 
-SNACKS.BIGFILE.SETUP() ~
+SNACKS.BIGFILE.SETUP()          *snacks-bigfile-module-snacks.bigfile.setup()*
 
 >lua
     Snacks.bigfile.setup()

diff --git a/doc/snacks-bufdelete.txt b/doc/snacks-bufdelete.txt
@@ -0,0 +1,36 @@
+*snacks-bufdelete.txt*         For Neovim        Last change: 2024 November 05
+
+==============================================================================
+Table of Contents                         *snacks-bufdelete-table-of-contents*
+
+1. Module                                            |snacks-bufdelete-module|
+  - Snacks.bufdelete()            |snacks-bufdelete-module-snacks.bufdelete()|
+  - Snacks.bufdelete.delete()|snacks-bufdelete-module-snacks.bufdelete.delete()|
+
+==============================================================================
+1. Module                                            *snacks-bufdelete-module*
+
+>lua
+    ---@class snacks.bufdelete
+    Snacks.bufdelete = {}
+<
+
+
+SNACKS.BUFDELETE()                *snacks-bufdelete-module-snacks.bufdelete()*
+
+>lua
+    ---@type fun(buf?: number)
+    Snacks.bufdelete()
+<
+
+
+SNACKS.BUFDELETE.DELETE()  *snacks-bufdelete-module-snacks.bufdelete.delete()*
+
+>lua
+    ---@param buf number?
+    Snacks.bufdelete.delete(buf)
+<
+
+Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
+
+vim:tw=78:ts=8:noet:ft=help:norl:
diff --git a/doc/snacks-debug.txt b/doc/snacks-debug.txt
@@ -0,0 +1,53 @@
+*snacks-debug.txt*           For Neovim          Last change: 2024 November 05
+
+==============================================================================
+Table of Contents                             *snacks-debug-table-of-contents*
+
+1. Module                                                |snacks-debug-module|
+  - Snacks.debug()                        |snacks-debug-module-snacks.debug()|
+  - Snacks.debug.backtrace()    |snacks-debug-module-snacks.debug.backtrace()|
+  - Snacks.debug.inspect()        |snacks-debug-module-snacks.debug.inspect()|
+  - Snacks.debug.profile()        |snacks-debug-module-snacks.debug.profile()|
+
+==============================================================================
+1. Module                                                *snacks-debug-module*
+
+>lua
+    ---@class snacks.debug
+    Snacks.debug = {}
+<
+
+
+SNACKS.DEBUG()                            *snacks-debug-module-snacks.debug()*
+
+>lua
+    ---@type fun(...)
+    Snacks.debug()
+<
+
+
+SNACKS.DEBUG.BACKTRACE()        *snacks-debug-module-snacks.debug.backtrace()*
+
+>lua
+    Snacks.debug.backtrace()
+<
+
+
+SNACKS.DEBUG.INSPECT()            *snacks-debug-module-snacks.debug.inspect()*
+
+>lua
+    Snacks.debug.inspect(...)
+<
+
+
+SNACKS.DEBUG.PROFILE()            *snacks-debug-module-snacks.debug.profile()*
+
+>lua
+    ---@param fn fun()
+    ---@param opts? {count?: number, flush?: boolean}
+    Snacks.debug.profile(fn, opts)
+<
+
+Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
+
+vim:tw=78:ts=8:noet:ft=help:norl:
diff --git a/doc/snacks.nvim-git.txt → doc/snacks-git.txt b/doc/snacks.nvim-git.txt → doc/snacks-git.txt
@@ -1,24 +1,22 @@
-*snacks.nvim-git.txt*         For Neovim         Last change: 2024 November 05
+*snacks-git.txt*            For Neovim           Last change: 2024 November 05
 
 ==============================================================================
-Table of Contents                          *snacks.nvim-git-table-of-contents*
+Table of Contents                               *snacks-git-table-of-contents*
 
-1. git                                                   |snacks.nvim-git-git|
-  - Module                                        |snacks.nvim-git-git-module|
+1. Module                                                  |snacks-git-module|
+  - Snacks.git.blame_line()        |snacks-git-module-snacks.git.blame_line()|
+  - Snacks.git.get_root()            |snacks-git-module-snacks.git.get_root()|
 
 ==============================================================================
-1. git                                                   *snacks.nvim-git-git*
-
-
-MODULE                                            *snacks.nvim-git-git-module*
+1. Module                                                  *snacks-git-module*
 
 >lua
     ---@class snacks.git
     Snacks.git = {}
 <
 
 
-SNACKS.GIT.BLAME_LINE() ~
+SNACKS.GIT.BLAME_LINE()            *snacks-git-module-snacks.git.blame_line()*
 
 Show git log for the current line.
 
@@ -28,7 +26,7 @@ Show git log for the current line.
 <
 
 
-SNACKS.GIT.GET_ROOT() ~
+SNACKS.GIT.GET_ROOT()                *snacks-git-module-snacks.git.get_root()*
 
 Gets the git root for a buffer or path. Defaults to the current buffer.
 

diff --git a/doc/snacks.nvim-gitbrowse.txt → doc/snacks-gitbrowse.txt b/doc/snacks.nvim-gitbrowse.txt → doc/snacks-gitbrowse.txt
@@ -1,17 +1,16 @@
-*snacks.nvim-gitbrowse.txt*      For Neovim      Last change: 2024 November 05
+*snacks-gitbrowse.txt*         For Neovim        Last change: 2024 November 05
 
 ==============================================================================
-Table of Contents                    *snacks.nvim-gitbrowse-table-of-contents*
+Table of Contents                         *snacks-gitbrowse-table-of-contents*
 
-1. gitbrowse                                 |snacks.nvim-gitbrowse-gitbrowse|
-  - Config                            |snacks.nvim-gitbrowse-gitbrowse-config|
-  - Module                            |snacks.nvim-gitbrowse-gitbrowse-module|
+1. Config                                            |snacks-gitbrowse-config|
+2. Module                                            |snacks-gitbrowse-module|
+  - Snacks.gitbrowse()            |snacks-gitbrowse-module-snacks.gitbrowse()|
+  - Snacks.gitbrowse.get_url()|snacks-gitbrowse-module-snacks.gitbrowse.get_url()|
+  - Snacks.gitbrowse.open()  |snacks-gitbrowse-module-snacks.gitbrowse.open()|
 
 ==============================================================================
-1. gitbrowse                                 *snacks.nvim-gitbrowse-gitbrowse*
-
-
-CONFIG                                *snacks.nvim-gitbrowse-gitbrowse-config*
+1. Config                                            *snacks-gitbrowse-config*
 
 >lua
     ---@class snacks.gitbrowse.Config
@@ -42,23 +41,24 @@ CONFIG                                *snacks.nvim-gitbrowse-gitbrowse-config*
 <
 
 
-MODULE                                *snacks.nvim-gitbrowse-gitbrowse-module*
+==============================================================================
+2. Module                                            *snacks-gitbrowse-module*
 
 >lua
     ---@class snacks.gitbrowse
     Snacks.gitbrowse = {}
 <
 
 
-SNACKS.GITBROWSE() ~
+SNACKS.GITBROWSE()                *snacks-gitbrowse-module-snacks.gitbrowse()*
 
 >lua
     ---@type fun(opts?: snacks.gitbrowse.Config)
     Snacks.gitbrowse()
 <
 
 
-SNACKS.GITBROWSE.GET_URL() ~
+SNACKS.GITBROWSE.GET_URL()*snacks-gitbrowse-module-snacks.gitbrowse.get_url()*
 
 >lua
     ---@param remote string
@@ -67,7 +67,7 @@ SNACKS.GITBROWSE.GET_URL() ~
 <
 
 
-SNACKS.GITBROWSE.OPEN() ~
+SNACKS.GITBROWSE.OPEN()      *snacks-gitbrowse-module-snacks.gitbrowse.open()*
 
 >lua
     ---@param opts? snacks.gitbrowse.Config

diff --git a/doc/snacks.nvim-init.txt → doc/snacks-init.txt b/doc/snacks.nvim-init.txt → doc/snacks-init.txt
@@ -1,16 +1,15 @@
-*snacks.nvim-init.txt*         For Neovim        Last change: 2024 November 05
+*snacks-init.txt*           For Neovim           Last change: 2024 November 05
 
 ==============================================================================
-Table of Contents                         *snacks.nvim-init-table-of-contents*
+Table of Contents                              *snacks-init-table-of-contents*
 
-1. init                                                |snacks.nvim-init-init|
-  - Module                                      |snacks.nvim-init-init-module|
+1. Module                                                 |snacks-init-module|
+  - Snacks.config.get()               |snacks-init-module-snacks.config.get()|
+  - Snacks.config.view()             |snacks-init-module-snacks.config.view()|
+  - Snacks.setup()                         |snacks-init-module-snacks.setup()|
 
 ==============================================================================
-1. init                                                *snacks.nvim-init-init*
-
-
-MODULE                                          *snacks.nvim-init-init-module*
+1. Module                                                 *snacks-init-module*
 
 >lua
     ---@class Snacks
@@ -33,7 +32,7 @@ MODULE                                          *snacks.nvim-init-init-module*
 <
 
 
-SNACKS.CONFIG.GET() ~
+SNACKS.CONFIG.GET()                   *snacks-init-module-snacks.config.get()*
 
 >lua
     ---@generic T: table
@@ -45,7 +44,7 @@ SNACKS.CONFIG.GET() ~
 <
 
 
-SNACKS.CONFIG.VIEW() ~
+SNACKS.CONFIG.VIEW()                 *snacks-init-module-snacks.config.view()*
 
 Register a new window view config.
 
@@ -56,7 +55,7 @@ Register a new window view config.
 <
 
 
-SNACKS.SETUP() ~
+SNACKS.SETUP()                             *snacks-init-module-snacks.setup()*
 
 >lua
     ---@param opts snacks.Opts?

diff --git a/doc/snacks.nvim-lazygit.txt → doc/snacks-lazygit.txt b/doc/snacks.nvim-lazygit.txt → doc/snacks-lazygit.txt
@@ -1,18 +1,18 @@
-*snacks.nvim-lazygit.txt*       For Neovim       Last change: 2024 November 05
+*snacks-lazygit.txt*          For Neovim         Last change: 2024 November 05
 
 ==============================================================================
-Table of Contents                      *snacks.nvim-lazygit-table-of-contents*
+Table of Contents                           *snacks-lazygit-table-of-contents*
 
-1. lazygit                                       |snacks.nvim-lazygit-lazygit|
-  - Config                                |snacks.nvim-lazygit-lazygit-config|
-  - Types                                  |snacks.nvim-lazygit-lazygit-types|
-  - Module                                |snacks.nvim-lazygit-lazygit-module|
+1. Config                                              |snacks-lazygit-config|
+2. Types                                                |snacks-lazygit-types|
+3. Module                                              |snacks-lazygit-module|
+  - Snacks.lazygit()                  |snacks-lazygit-module-snacks.lazygit()|
+  - Snacks.lazygit.log()          |snacks-lazygit-module-snacks.lazygit.log()|
+  - Snacks.lazygit.log_file()|snacks-lazygit-module-snacks.lazygit.log_file()|
+  - Snacks.lazygit.open()        |snacks-lazygit-module-snacks.lazygit.open()|
 
 ==============================================================================
-1. lazygit                                       *snacks.nvim-lazygit-lazygit*
-
-
-CONFIG                                    *snacks.nvim-lazygit-lazygit-config*
+1. Config                                              *snacks-lazygit-config*
 
 >lua
     ---@class snacks.lazygit.Config: snacks.terminal.Config
@@ -40,7 +40,8 @@ CONFIG                                    *snacks.nvim-lazygit-lazygit-config*
 <
 
 
-TYPES                                      *snacks.nvim-lazygit-lazygit-types*
+==============================================================================
+2. Types                                                *snacks-lazygit-types*
 
 >lua
     ---@alias snacks.lazygit.Color {fg?:string, bg?:string, bold?:boolean}
@@ -60,39 +61,40 @@ TYPES                                      *snacks.nvim-lazygit-lazygit-types*
 <
 
 
-MODULE                                    *snacks.nvim-lazygit-lazygit-module*
+==============================================================================
+3. Module                                              *snacks-lazygit-module*
 
 >lua
     ---@class snacks.lazygit
     Snacks.lazygit = {}
 <
 
 
-SNACKS.LAZYGIT() ~
+SNACKS.LAZYGIT()                      *snacks-lazygit-module-snacks.lazygit()*
 
 >lua
     ---@type fun(opts?: snacks.lazygit.Config): snacks.win
     Snacks.lazygit()
 <
 
 
-SNACKS.LAZYGIT.LOG() ~
+SNACKS.LAZYGIT.LOG()              *snacks-lazygit-module-snacks.lazygit.log()*
 
 >lua
     ---@param opts? snacks.lazygit.Config
     Snacks.lazygit.log(opts)
 <
 
 
-SNACKS.LAZYGIT.LOG_FILE() ~
+SNACKS.LAZYGIT.LOG_FILE()    *snacks-lazygit-module-snacks.lazygit.log_file()*
 
 >lua
     ---@param opts? snacks.lazygit.Config
     Snacks.lazygit.log_file(opts)
 <
 
 
-SNACKS.LAZYGIT.OPEN() ~
+SNACKS.LAZYGIT.OPEN()            *snacks-lazygit-module-snacks.lazygit.open()*
 
 Opens lazygit