diff options
| author | James Trew <66286082+jamestrew@users.noreply.github.com> | 2023-01-22 03:57:53 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-01-22 09:57:53 +0100 |
| commit | 053f2303c4fac5c45a56b9de0a7481b7db94d6ba (patch) | |
| tree | 8520fa13cfb0008d111ad17038748303891a9f7f /lua/telescope/builtin/init.lua | |
| parent | ed366bba143d9babd2b81eb46c4f0f482051778d (diff) | |
docs: proof-read edits (#2311)
Diffstat (limited to 'lua/telescope/builtin/init.lua')
| -rw-r--r-- | lua/telescope/builtin/init.lua | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/lua/telescope/builtin/init.lua b/lua/telescope/builtin/init.lua index 0f4c998..3036820 100644 --- a/lua/telescope/builtin/init.lua +++ b/lua/telescope/builtin/init.lua @@ -96,7 +96,7 @@ builtin.treesitter = require_on_exported_call("telescope.builtin.__files").trees --- Live fuzzy search inside of the currently open buffer ---@param opts table: options to pass to the picker ----@field skip_empty_lines boolean: if true we dont display empty lines (default: false) +---@field skip_empty_lines boolean: if true we don't display empty lines (default: false) builtin.current_buffer_fuzzy_find = require_on_exported_call("telescope.builtin.__files").current_buffer_fuzzy_find --- Lists tags in current directory with tag location file preview (users are required to run ctags -R to generate tags @@ -133,7 +133,7 @@ builtin.current_buffer_tags = require_on_exported_call("telescope.builtin.__file ---@field use_git_root boolean: if we should use git root as cwd or the cwd (important for submodule) (default: true) ---@field show_untracked boolean: if true, adds `--others` flag to command and shows untracked files (default: false) ---@field recurse_submodules boolean: if true, adds the `--recurse-submodules` flag to command (default: false) ----@field git_command table: command that will be exectued. {"git","ls-files","--exclude-standard","--cached"} +---@field git_command table: command that will be executed. {"git","ls-files","--exclude-standard","--cached"} builtin.git_files = require_on_exported_call("telescope.builtin.__git").files --- Lists commits for current directory with diff preview @@ -145,11 +145,11 @@ builtin.git_files = require_on_exported_call("telescope.builtin.__git").files ---@param opts table: options to pass to the picker ---@field cwd string: specify the path of the repo ---@field use_git_root boolean: if we should use git root as cwd or the cwd (important for submodule) (default: true) ----@field git_command table: command that will be exectued. {"git","log","--pretty=oneline","--abbrev-commit","--","."} +---@field git_command table: command that will be executed. {"git","log","--pretty=oneline","--abbrev-commit","--","."} builtin.git_commits = require_on_exported_call("telescope.builtin.__git").commits --- Lists commits for current buffer with diff preview ---- - Default keymaps or your overriden `select_` keys: +--- - Default keymaps or your overridden `select_` keys: --- - `<cr>`: checks out the currently selected commit --- - `<c-v>`: opens a diff in a vertical split --- - `<c-x>`: opens a diff in a horizontal split @@ -158,7 +158,7 @@ builtin.git_commits = require_on_exported_call("telescope.builtin.__git").commit ---@field cwd string: specify the path of the repo ---@field use_git_root boolean: if we should use git root as cwd or the cwd (important for submodule) (default: true) ---@field current_file string: specify the current file that should be used for bcommits (default: current buffer) ----@field git_command table: command that will be exectued. {"git","log","--pretty=oneline","--abbrev-commit"} +---@field git_command table: command that will be executed. {"git","log","--pretty=oneline","--abbrev-commit"} builtin.git_bcommits = require_on_exported_call("telescope.builtin.__git").bcommits --- List branches for current directory, with output from `git log --oneline` shown in the preview window @@ -224,8 +224,8 @@ builtin.pickers = require_on_exported_call("telescope.builtin.__internal").picke --- Use the telescope... ---@param opts table: options to pass to the picker ----@field show_pluto boolean: we love pluto (default: false, because its a hidden feature) ----@field show_moon boolean: we love the moon (default: false, because its a hidden feature) +---@field show_pluto boolean: we love Pluto (default: false, because its a hidden feature) +---@field show_moon boolean: we love the Moon (default: false, because its a hidden feature) builtin.planets = require_on_exported_call("telescope.builtin.__internal").planets --- Lists symbols inside of `data/telescope-sources/*.json` found in your runtime path |
