summaryrefslogtreecommitdiff
path: root/lua/telescope/pickers/entry_display.lua
diff options
context:
space:
mode:
authorTsakiris Tryfon <tr.tsakiris@gmail.com>2022-12-28 15:49:57 +0200
committerGitHub <noreply@github.com>2022-12-28 14:49:57 +0100
commita606bd10c79ec5989c76c49cc6f736e88b63f0da (patch)
tree1a7cb5aabf8453140f52d381a77699d311405833 /lua/telescope/pickers/entry_display.lua
parent01d92285ef4402b188fa583d57f5d1a18c889d22 (diff)
docs: fix typos/wording (#2283)
Diffstat (limited to 'lua/telescope/pickers/entry_display.lua')
-rw-r--r--lua/telescope/pickers/entry_display.lua22
1 files changed, 11 insertions, 11 deletions
diff --git a/lua/telescope/pickers/entry_display.lua b/lua/telescope/pickers/entry_display.lua
index 6e520f4..864e2b3 100644
--- a/lua/telescope/pickers/entry_display.lua
+++ b/lua/telescope/pickers/entry_display.lua
@@ -14,9 +14,9 @@
--- The create function will use the column widths passed to it in
--- configaration.items. Each item in that table is the number of characters in
--- the column. It's also possible for the final column to not have a fixed
---- width, this will be shown in the configuartion as 'remaining = true'.
+--- width, this will be shown in the configuration as 'remaining = true'.
---
---- An example of this configuration is shown for the buffers picker
+--- An example of this configuration is shown for the buffers picker:
--- <code>
--- local displayer = entry_display.create {
--- separator = " ",
@@ -30,10 +30,10 @@
--- </code>
---
--- This shows 4 columns, the first is defined in the opts as the width we'll
---- use when display_string the number of the buffer. The second has a fixed
---- width of 4 and the 3rd column's widht will be decided by the width of the
---- icons we use. The fourth column will use the remaining space. Finally we
---- have also defined the seperator between each column will be the space " ".
+--- use when display_string is the number of the buffer. The second has a fixed
+--- width of 4 and the third column's width will be decided by the width of the
+--- icons we use. The fourth column will use the remaining space. Finally, we
+--- have also defined the separator between each column will be the space " ".
---
--- An example of how the display reference will be used is shown, again for
--- the buffers picker:
@@ -49,12 +49,12 @@
--- There are two types of values each column can have. Either a simple String
--- or a table containing the String as well as the hl_group.
---
---- The displayer can return values, string and an optional highlights.
---- String is all the text to be displayed for this entry as a single string. If
---- parts of the string are to be highlighted they will be described in the
---- highlights table.
+--- The displayer can return values, string and an optional highlights. The string
+--- is all the text to be displayed for this entry as a single string. If parts of
+--- the string are to be highlighted they will be described in the highlights
+--- table.
---
---- For better understanding of how create() and displayer are used it's best to look
+--- For a better understanding of how create() and displayer are used it's best to look
--- at the code in make_entry.lua.
---@brief ]]