Updated docs to clarify which telescope.defaults options can be overriden by pickers #3251
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jamestrew
requested changes
Sep 11, 2024
| @@ -106,18 +106,26 @@ local telescope = {} | |||
| --- pickers = { | |||
| --- -- Default configuration for builtin pickers goes here: | |||
| --- -- picker_name = { | |||
| --- -- picker_config_key = value, | |||
| --- -- default_config_key = value_one | |||
There was a problem hiding this comment.
Suggested change
| --- -- default_config_key = value_one | |
| --- -- default_config_key = value_one, -- optionally override any default options |
| --- of the options you want to use. Pickers have their own specific set of | ||
| --- options, but also accept a subset of the defaults options. The default | ||
| --- options which are valid to configure a picker are marked as | ||
| --- "Picker-Overridable" in telescope.setup.defaults |
There was a problem hiding this comment.
It'll probably be easier to mark options that aren't "picker-overriable".
In theory, all but a small handful can at least in technically be overriden by the each individual picker.
I would reword this bit slightly and let's leave out the marking of individual options an "Picker-Overridable" for now.
Comment on lines
+113
to
+118
| --- -- Options set here will be applied everytime you call this builtin | ||
| --- -- picker. Each entry accepts a subset of the "defaults" configuration | ||
| --- -- options, as well as the picker's own specific configuration options. | ||
| --- -- Defaults options that are also valid for pickers are marked as | ||
| --- -- "Picker-Overridable" in telescope.setup.defaults. Learn about one | ||
| --- -- picker's specific set of options at telescope.builtin.$PICKER_NAME |
There was a problem hiding this comment.
Suggested change
| --- -- Options set here will be applied everytime you call this builtin | |
| --- -- picker. Each entry accepts a subset of the "defaults" configuration | |
| --- -- options, as well as the picker's own specific configuration options. | |
| --- -- Defaults options that are also valid for pickers are marked as | |
| --- -- "Picker-Overridable" in telescope.setup.defaults. Learn about one | |
| --- -- picker's specific set of options at telescope.builtin.$PICKER_NAME | |
| --- -- Options set here will be applied everytime you call this builtin | |
| --- -- picker. The pickers will also inherit the "default" options unless | |
| --- -- they are overwritten. | |
| --- -- See `:h telescope.builtin` for options unique to each picker. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Fixes #3238
The documentation isn't very clear about what keys are valid for pickers config options. There is a subset of of defaults options that pickers can override and it's not clear which ones are.
Type of change
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list relevant details about your configuration
make testmake lintConfiguration:
Neovim version (nvim --version): NVIM v0.10.1
Operating system and version: Debian 12
Checklist: