diff options
| author | Sam Rosenthal <39362114+SammRosenthal@users.noreply.github.com> | 2022-09-04 15:55:54 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-09-04 21:55:54 +0200 |
| commit | bd9e8a7eac1b3f921d293866abf7574d49cb610c (patch) | |
| tree | 33aa81abc5db6de0b210c73a184cd0f066053635 | |
| parent | 2b5060362bc6821faacc346a3069812446a14d68 (diff) | |
docs: update for git_files and live_grep (#2133)
| -rw-r--r-- | README.md | 4 | ||||
| -rw-r--r-- | doc/telescope.txt | 6 | ||||
| -rw-r--r-- | lua/telescope/builtin/init.lua | 6 |
3 files changed, 7 insertions, 9 deletions
@@ -270,9 +270,9 @@ Built-in functions. Ready to be bound to any key you like. | Functions | Description | |-------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------| | `builtin.find_files` | Lists files in your current working directory, respects .gitignore | -| `builtin.git_files` | Fuzzy search through the output of `git ls-files` command, respects .gitignore, optionally ignores untracked files | +| `builtin.git_files` | Fuzzy search through the output of `git ls-files` command, respects .gitignore | | `builtin.grep_string` | Searches for the string under your cursor in your current working directory | -| `builtin.live_grep` | Search for a string in your current working directory and get results live as you type (respecting .gitignore) | +| `builtin.live_grep` | Search for a string in your current working directory and get results live as you type, respects .gitignore | ### Vim Pickers diff --git a/doc/telescope.txt b/doc/telescope.txt index 8d44c04..d4f855e 100644 --- a/doc/telescope.txt +++ b/doc/telescope.txt @@ -765,8 +765,7 @@ options you want to use. Here's an example with the live_grep picker: < builtin.live_grep({opts}) *telescope.builtin.live_grep()* - Search for a string and get results live as you type (respecting - .gitignore) + Search for a string and get results live as you type, respects .gitignore Parameters: ~ @@ -938,8 +937,7 @@ builtin.current_buffer_tags({opts}) *telescope.builtin.current_buffer_tags()* builtin.git_files({opts}) *telescope.builtin.git_files()* Fuzzy search for files tracked by Git. This command lists the output of the - `git ls-files` command, respects .gitignore, and optionally ignores - untracked files + `git ls-files` command, respects .gitignore - Default keymaps: - `<cr>`: opens the currently selected file diff --git a/lua/telescope/builtin/init.lua b/lua/telescope/builtin/init.lua index 6b27156..03b3134 100644 --- a/lua/telescope/builtin/init.lua +++ b/lua/telescope/builtin/init.lua @@ -45,7 +45,7 @@ end -- -- ---- Search for a string and get results live as you type (respecting .gitignore) +--- Search for a string and get results live as you type, respects .gitignore ---@param opts table: options to pass to the picker ---@field cwd string: root dir to search from (default: cwd, use utils.buffer_dir() to search relative to open buffer) ---@field grep_open_files boolean: if true, restrict search to open files only, mutually exclusive with `search_dirs` @@ -123,8 +123,8 @@ builtin.current_buffer_tags = require_on_exported_call("telescope.builtin.__file -- -- ---- Fuzzy search for files tracked by Git. This command lists the output of the `git ls-files` command, respects ---- .gitignore, and optionally ignores untracked files +--- Fuzzy search for files tracked by Git. This command lists the output of the `git ls-files` command, +--- respects .gitignore --- - Default keymaps: --- - `<cr>`: opens the currently selected file ---@param opts table: options to pass to the picker |