leigh/telescope.nvim
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: telescope.nvim spelling and grammar fixes (#2325)

Browse Source 
Corrects the following issues:
- article agreement
- spelling
This commit is contained in:
vladislav doster
2023-01-22 03:07:45 -06:00
committed by GitHub
parent 053f2303c4
commit dce1156ca1
3 changed files with 16 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
doc/telescope.txt
View File

@@ -3287,7 +3287,7 @@ PREVIEWERS *telescope.previewers*
Provides a Previewer table that has to be implemented by each previewer. To
achieve this, this module also provides two wrappers that abstract most of the
work and make it really easy create new previewers.
work and make it really easy to create new previewers.
- `previewers.new_termopen_previewer`
- `previewers.new_buffer_previewer`
@@ -3316,7 +3316,7 @@ previewers.Previewer() *telescope.previewers.Previewer()*
What `:new` expects is listed below
The interface provides following set of functions. All of them, besides
The interface provides the following set of functions. All of them, besides
`new`, will be handled by telescope pickers.
- `:new(opts)`
- `:preview(entry, status)`
@@ -3327,7 +3327,7 @@ previewers.Previewer() *telescope.previewers.Previewer()*
`Previewer:new()` expects a table as input with following keys:
- `setup` function(self): Will be called the first time preview will be
called.
- `teardown` function(self): Will be called on cleanup.
- `teardown` function(self): Will be called on clean up.
- `preview_fn` function(self, entry, status): Will be called each time a
new entry was selected.
- `title` function(self): Will return the static title of the previewer.
@@ -3437,9 +3437,9 @@ previewers.new_buffer_previewer() *telescope.previewers.new_buffer_previewer()*
table of vars that will be available in `self.state` in each
`define_preview` call.
- `teardown = function(self)` (optional) Will be called at the end, when
the picker is being closed and is meant to cleanup everything that was
the picker is being closed and is meant to clean up everything that was
allocated by the previewer. The `buffer_previewer` will automatically
cleanup all created buffers. So you only need to handle things that
clean up all created buffers. So you only need to handle things that
were introduced by you.
- `keep_last_buf = true` (optional) Will not delete the last selected
buffer. This would allow you to reuse that buffer in the select action.
@@ -3447,7 +3447,7 @@ previewers.new_buffer_previewer() *telescope.previewers.new_buffer_previewer()*
recreating that buffer in an action. To access the last buffer number:
`require('telescope.state').get_global_key("last_preview_bufnr")`
- `get_buffer_by_name = function(self, entry)` Allows you to set a unique
name for each buffer. This is used for caching purpose.
name for each buffer. This is used for caching purposes.
`self.state.bufname` will be nil if the entry was never loaded or the
unique name when it was loaded once. For example, useful if you have
one file but multiple entries. This happens for grep and lsp builtins.
@@ -3543,7 +3543,7 @@ previewers.vim_buffer_vimgrep() *telescope.previewers.vim_buffer_vimgrep()*
previewers.vim_buffer_qflist() *telescope.previewers.vim_buffer_qflist()*
Is the same as `vim_buffer_vimgrep` and only exist for consistency with
Is the same as `vim_buffer_vimgrep` and only exists for consistency with
`term_previewers`.
The preferred way of using this previewer is like this
@@ -3614,7 +3614,7 @@ HISTORY *telescope.actions.history*
A base implementation of a prompt history that provides a simple history and
can be replaced with a custom implementation.
For example: We provide a extension for a smart history that uses sql.nvim to
For example: We provide an extension for a smart history that uses sql.nvim to
map histories to metadata, like the calling picker or cwd.
So you have a history for: