Merge pull request #9 from jan-xyz/improve_docs

improve documentation
jan-xyz · Apr 7, 2024 · 6b62bd7 · 6b62bd7
2 parents 3494517 + bc3621e
commit 6b62bd7
Showing 1 changed file with 10 additions and 12 deletions.
diff --git a/doc/lsp-preview.txt b/doc/lsp-preview.txt
@@ -10,11 +10,13 @@ lsp-preview.setup({opts})                                *lsp-preview.setup()*
 change the default options.
 
 Parameters ~
-{opts} `(table|nil)` Module config table. See |lsp-preview.config|.
+{opts} `(table|nil)` Module config table.
+  - <preview> `(boolean)` - default for the `preview` flag. (default: false)
+  - <apply> `(boolean)` - skip the code action selection if there is only one. (default: true)
 
-lsp-preview.code_action({opts})    *lsp-preview.code_action()*
+lsp-preview.code_action({opts})                    *lsp-preview.code_action()*
 
-drop-in replacement for `vim.lsp.buf.code_action` which can previews the changes
+Drop-in replacement for `vim.lsp.buf.code_action` which can previews the changes
 and allows for pre-selection before applying it.
 
 Parameters ~
@@ -23,27 +25,23 @@ Parameters ~
 
 lsp-preview.code_action_preview({opts})    *lsp-preview.code_action_preview()*
 
-drop-in replacement for `vim.lsp.buf.code_action` which previews the changes
-and allows for pre-selection before applying it. It is a wrapper for
-|lsp-preview.code_action| with `preview = true`.
+It is a wrapper for |lsp-preview.code_action| with `preview = true`.
 
 Parameters ~
 {opts} `(table|nil)` tbd
 
-lsp-preview.rename({opts})    *lsp-preview.rename()*
+lsp-preview.rename({opts})                              *lsp-preview.rename()*
 
-drop-in replacement for `vim.lsp.buf.rename` which can previews the changes
+Drop-in replacement for `vim.lsp.buf.rename` which can previews the changes
 and allows for pre-selection before applying it.
 
 Parameters ~
 {opts} `(table|nil)` Module config table. See |lsp-preview.config|.
   - <preview> `(boolean)` - setting to activate the preview mode.
 
-lsp-preview.rename_preview({opts})    *lsp-preview.rename_preview()*
+lsp-preview.rename_preview({opts})              *lsp-preview.rename_preview()*
 
-drop-in replacement for `vim.lsp.buf.rename` which previews the changes
-and allows for pre-selection before applying it. It is a wrapper for
-|lsp-preview.rename| with `preview = true`.
+It is a wrapper for |lsp-preview.rename| with `preview = true`.
 
 Parameters ~
 {opts} `(table|nil)` tbd