fix: update docs

jonathanmorris180 · Jan 17, 2024 · 068901f · 068901f
1 parent 8664c13
commit 068901f
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -106,8 +106,10 @@ There are a number of options available to configure `salesforce.nvim`. See the
 
 ```lua
 require("salesforce").setup({
-    -- Prints useful logs about what events are triggered, as well as outputs of the Salesforce CLI
-    debug = false,
+    debug = {
+        to_file = false,
+        to_console = false,
+    },
     popup = {
         -- The width of the popup window.
         width = 100,

diff --git a/doc/salesforce.txt b/doc/salesforce.txt
@@ -26,8 +26,10 @@ To use this plugin, you must first setup your project by running `require("sales
 You can pass in a lua table of options to customize the plugin. The default options are:
 >
 {
-    -- Prints useful logs about what events are triggered, as well as outputs of the Salesforce CLI
-    debug = false,
+    debug = {
+        to_file = false, -- logs debug messages to a file at vim.fn.stdpath("cache") .. "/salesforce.log"
+        to_console = false,
+    },
     popup = {
         -- The width of the popup window.
         width = 100,

diff --git a/lua/salesforce/init.lua b/lua/salesforce/init.lua
@@ -22,8 +22,10 @@
 --- You can pass in a lua table of options to customize the plugin. The default options are:
 --- >
 --- {
----     -- Prints useful logs about what events are triggered, as well as outputs of the Salesforce CLI
----     debug = false,
+---     debug = {
+---         to_file = false, -- logs debug messages to a file at vim.fn.stdpath("cache") .. "/salesforce.log"
+---         to_console = false,
+---     },
 ---     popup = {
 ---         -- The width of the popup window.
 ---         width = 100,