docs: Auto-generate user / API documentation + vimtags

YaroSpace · Jan 25, 2025 · 85f52c6 · 85f52c6
1 parent e7e12a3
commit 85f52c6
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 22 deletions.
diff --git a/doc/lua-console.nvim.txt b/doc/lua-console.nvim.txt
@@ -39,32 +39,44 @@ the whole thing again, copying the paths from error stacktraces and so on. I
 needed something better, so there it is.
 
 
+
+
 ✨ FEATURES*lua-console.nvim-💻-lua-console-main-develop-luarocks-✨-features*
 
 - Evaluate single line expressions and statements, visually selected lines of code or the whole buffer
-- Pretty print Lua objects, including function details and their source paths
-- Show normal and error output in the console/buffer, including output of `print()`, errors and stacktraces.
+- Pretty print Lua objects, including results of assignments, function details and their source paths
+- Show normal and error output inline in the console/buffer, including output of `print()`, errors and stacktraces.
 - Syntax highlighting and autocompletion
-- Load Neovim’s messages into console for inspection and copy/paste
+- Load Neovim’s messages and output of ex commands into console for inspection and copy/paste
 - Open links from stacktraces and function sources
 - Save / Load / Autosave console session
 - Use as a scratch pad for code gists
 - Attach code evaluators to any buffer
 
 
+
+
 📦 INSTALLATION*lua-console.nvim-💻-lua-console-main-develop-luarocks-📦-installation*
 
 With lazy.nvim <https://github.com/folke/lazy.nvim>:
 
 >lua
     return {
       "yarospace/lua-console.nvim",
-      lazy = true, keys = "`", opts = {},
+      lazy = true, 
+      keys = {'`', '<Leader>`'},
+      opts = {},
     }
 <
 
-otherwise, install with your favorite package manager and add
-`require('lua-console').setup { custom_options }` somewhere in your config.
+otherwise, install with your favorite package manager and add somewhere in your
+config:
+
+>lua
+    require('lua-console').setup { your_custom_options }
+<
+
+
 
 
 ⚙️ CONFIGURATION*lua-console.nvim-💻-lua-console-main-develop-luarocks-⚙️-configuration*
@@ -111,6 +123,8 @@ Default Settings ~
 <
 
 
+
+
 🚀 BASIC USAGE (WITH DEFAULT MAPPINGS)*lua-console.nvim-💻-lua-console-main-develop-luarocks-🚀-basic-usage-(with-default-mappings)*
 
 - Install, press the mapped key ``` and start exploring.
@@ -135,6 +149,8 @@ Default Settings ~
 - You can resize the console with `<C-Up>` and `<C-Down>`.
 
 
+
+
 📓 NOTES ON GLOBALS, LOCALS AND PRESERVING EXECUTION CONTEXT*lua-console.nvim-💻-lua-console-main-develop-luarocks-📓-notes-on-globals,-locals-and-preserving-execution-context*
 
 
@@ -160,6 +176,8 @@ There are two functions available within the console:
 - `_ctx_clear()` - clears the context
 
 
+
+
 ⭐ EXTRA FEATURES*lua-console.nvim-💻-lua-console-main-develop-luarocks-⭐-extra-features*
 
 
@@ -276,6 +294,8 @@ SETTING UP
     <
 
 
+
+
 ALTERNATIVES AND COMPARISON*lua-console.nvim-💻-lua-console-main-develop-luarocks-alternatives-and-comparison*
 
 There are a number of alternatives available, notably:
@@ -291,6 +311,8 @@ them, like REPL / scratch pad / code runner / debug console, while leaving the
 UX and config simple.
 
 
+
+
 🔥 ALL FEEDBACK AND FEATURE REQUESTS ARE VERY WELCOME! ENJOY!*lua-console.nvim-💻-lua-console-main-develop-luarocks-🔥-all-feedback-and-feature-requests-are-very-welcome!-enjoy!*
 
 Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>

diff --git a/doc/lua-console.nvim_api.txt b/doc/lua-console.nvim_api.txt
@@ -36,37 +36,35 @@ Parameters ~
     {buf} `(number)`
 
 ------------------------------------------------------------------------------
-                                                              *get_assignment()*
-
-`get_assignment`({line})
+                                                         *get_line_assignment()*
 
+`get_line_assignment`({line})
 
 if there is an assigment on the line and returns its value
-Parameters ~
-    {line} `(string[])`
-
-------------------------------------------------------------------------------
-                                                       *append_current_buffer()*
-
-`append_current_buffer`({buf}, {lines})
-
-Parameters ~
-    {buf} `(number)`
-    {lines} `(string[])` Text to append to current buffer after current selection
+line string[]
 
 ------------------------------------------------------------------------------
                                                                 *pretty_print()*
 
 `pretty_print`({...})
 
 
-prints objects and appends to print_buffer
+prints objects
 Parameters ~
     {...} `(any[])`
 
 Return ~
 `(string[])`
 
+------------------------------------------------------------------------------
+                                                       *append_current_buffer()*
+
+`append_current_buffer`({buf}, {lines})
+
+Parameters ~
+    {buf} `(number)`
+    {lines} `(string[])` Text to append to current buffer after current selection
+
 ------------------------------------------------------------------------------
                                                             *clean_stacktrace()*
 

diff --git a/doc/tags b/doc/tags
@@ -3,9 +3,9 @@ attach_toggle()	lua-console.nvim_api.txt	/*attach_toggle()*
 clean_stacktrace()	lua-console.nvim_api.txt	/*clean_stacktrace()*
 default_handler()	lua-console.nvim_api.txt	/*default_handler()*
 eval_code_in_buffer()	lua-console.nvim_api.txt	/*eval_code_in_buffer()*
-get_assignment()	lua-console.nvim_api.txt	/*get_assignment()*
 get_external_evaluator()	lua-console.nvim_api.txt	/*get_external_evaluator()*
 get_lang()	lua-console.nvim_api.txt	/*get_lang()*
+get_line_assignment()	lua-console.nvim_api.txt	/*get_line_assignment()*
 load_messages()	lua-console.nvim_api.txt	/*load_messages()*
 load_saved_console()	lua-console.nvim_api.txt	/*load_saved_console()*
 lua-console.nvim-table-of-contents	lua-console.nvim.txt	/*lua-console.nvim-table-of-contents*