docs: rewrite readme and add missing config values + builtin opts

2 files changed, 30 insertions, 28 deletions

diff --git a/lua/telescope/actions/generate.lua b/lua/telescope/actions/generate.lua
index fafce8c..40fc4b7 100644
--- a/lua/telescope/actions/generate.lua
+++ b/lua/telescope/actions/generate.lua
@@ -3,8 +3,8 @@
 ---@brief [[
 --- Module for convenience to override defaults of corresponding |telescope.actions| at |telescope.setup()|.
 ---
---- <pre>
 --- General usage:
+--- <code>
 ---   require("telescope").setup {
 ---     defaults = {
 ---       mappings = {
@@ -19,7 +19,7 @@
 ---       },
 ---     },
 ---   }
---- </pre>
+--- </code>
 ---@brief ]]
 
 local actions = require "telescope.actions"
diff --git a/lua/telescope/actions/utils.lua b/lua/telescope/actions/utils.lua
index 7c8a3ac..4d0c17d 100644
--- a/lua/telescope/actions/utils.lua
+++ b/lua/telescope/actions/utils.lua
@@ -16,20 +16,21 @@ local utils = {}
 ---   - Indices are 1-indexed, whereas rows are 0-indexed.
 --- - Warning: `map_entries` has no return value.
 ---   - The below example showcases how to collect results
---- <pre>
+---
 --- Usage:
----     local action_state = require "telescope.actions.state"
----     local action_utils = require "telescope.actions.utils"
----     function entry_value_by_row()
----       local prompt_bufnr = vim.api.nvim_get_current_buf()
----       local current_picker = action_state.get_current_picker(prompt_bufnr)
----       local results = {}
----         action_utils.map_entries(prompt_bufnr, function(entry, index, row)
----         results[row] = entry.value
----       end)
----       return results
----     end
---- </pre>
+--- <code>
+---   local action_state = require "telescope.actions.state"
+---   local action_utils = require "telescope.actions.utils"
+---   function entry_value_by_row()
+---     local prompt_bufnr = vim.api.nvim_get_current_buf()
+---     local current_picker = action_state.get_current_picker(prompt_bufnr)
+---     local results = {}
+---       action_utils.map_entries(prompt_bufnr, function(entry, index, row)
+---       results[row] = entry.value
+---     end)
+---     return results
+---   end
+--- </code>
 ---@param prompt_bufnr number: The prompt bufnr
 ---@param f function: Function to map onto entries of picker that takes (entry, index, row) as viable arguments
 function utils.map_entries(prompt_bufnr, f)
@@ -52,20 +53,21 @@ end
 ---   - Selected entries are returned in order of their selection.
 --- - Warning: `map_selections` has no return value.
 ---   - The below example showcases how to collect results
---- <pre>
+---
 --- Usage:
----     local action_state = require "telescope.actions.state"
----     local action_utils = require "telescope.actions.utils"
----     function selection_by_index()
----       local prompt_bufnr = vim.api.nvim_get_current_buf()
----       local current_picker = action_state.get_current_picker(prompt_bufnr)
----       local results = {}
----         action_utils.map_selections(prompt_bufnr, function(entry, index)
----         results[index] = entry.value
----       end)
----       return results
----     end
---- </pre>
+--- <code>
+---   local action_state = require "telescope.actions.state"
+---   local action_utils = require "telescope.actions.utils"
+---   function selection_by_index()
+---     local prompt_bufnr = vim.api.nvim_get_current_buf()
+---     local current_picker = action_state.get_current_picker(prompt_bufnr)
+---     local results = {}
+---       action_utils.map_selections(prompt_bufnr, function(entry, index)
+---       results[index] = entry.value
+---     end)
+---     return results
+---   end
+--- </code>
 ---@param prompt_bufnr number: The prompt bufnr
 ---@param f function: Function to map onto selection of picker that takes (selection) as a viable argument
 function utils.map_selections(prompt_bufnr, f)