From 5131df7df17d640191201ddb462e863022d7a61b Mon Sep 17 00:00:00 2001
From: Simon Hauser <Simon-Hauser@outlook.de>
Date: Mon, 13 Sep 2021 22:03:41 +0200
Subject: docs: rewrite readme and add missing config values + builtin opts

---
 lua/telescope/actions/utils.lua | 54 +++++++++++++++++++++--------------------
 1 file changed, 28 insertions(+), 26 deletions(-)

(limited to 'lua/telescope/actions/utils.lua')

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)
-- 
cgit v1.2.3