chore: docs

Author: shortcuts

doc/search-and-replace.txt

@@ -1,20 +1,3 @@
-==============================================================================
-------------------------------------------------------------------------------
-                                                     *SearchAndReplace.toggle()*
-                          `SearchAndReplace.toggle`()
-Toggle the plugin by calling the `enable`/`disable` methods respectively.
-
-------------------------------------------------------------------------------
-                                                     *SearchAndReplace.enable()*
-                       `SearchAndReplace.enable`({scope})
-Initializes the plugin, sets event listeners and o state.
-
-------------------------------------------------------------------------------
-                                                    *SearchAndReplace.disable()*
-                          `SearchAndReplace.disable`()
-Disables the plugin, clear highlight groups and autocmds, closes side buffers and resets the o state.
-
-
 ==============================================================================
 ------------------------------------------------------------------------------
                                                       *SearchAndReplace.options*
@@ -28,6 +11,25 @@ Default values:
   SearchAndReplace.options = {
       -- Prints useful logs about what event are triggered, and reasons actions are executed.
       debug = false,
+      -- Creates mappings for you to easily interact with the exposed commands.
+      ---@type table
+      mappings = {
+          -- When `true`, creates all the mappings that are not set to `false`.
+          ---@type boolean
+          enabled = false,
+          -- Sets a global mapping to Neovim, which will trigger the "by pattern" replace function.
+          -- When `false`, the mapping is not created.
+          ---@type string
+          search_and_replace_by_pattern = "<Leader>srp",
+          -- Sets a global mapping to Neovim, which will trigger the "by reference" replace function.
+          -- When `false`, the mapping is not created.
+          ---@type string
+          search_and_replace_by_reference = "<Leader>srr",
+          -- Sets a global mapping to Neovim, which will trigger the "undo" function.
+          -- When `false`, the mapping is not created.
+          ---@type string
+          undo = "<Leader>sru",
+      },
   }
 
 <
@@ -43,4 +45,4 @@ Usage ~
 `require("search-and-replace").setup()` (add `{}` with your |SearchAndReplace.options| table)
 
 
- vim:tw=78:ts=8:noet:ft=help:norl:
+ vim:tw=78:ts=8:noet:ft=help:norl:

doc/tags

@@ -1,5 +1,2 @@
-SearchAndReplace.disable()	search-and-replace.txt	/*SearchAndReplace.disable()*
-SearchAndReplace.enable()	search-and-replace.txt	/*SearchAndReplace.enable()*
 SearchAndReplace.options	search-and-replace.txt	/*SearchAndReplace.options*
 SearchAndReplace.setup()	search-and-replace.txt	/*SearchAndReplace.setup()*
-SearchAndReplace.toggle()	search-and-replace.txt	/*SearchAndReplace.toggle()*