wip: new setup docs#3670
Draft
jamestrew wants to merge 1 commit into
Draft
Conversation
This was referenced May 25, 2026
Contributor
|
Ouch, that looks like a lot more work than I anticipated... And, yeah, the dynamic nature and complex dependencies is a general issue that makes telescope maintenance so difficult... I am honestly not sure how much of this is necessary/useful and how much was just "we do what we must because we can" showing off... I do think that the concept of extensions is core to the telescope identity (moreso than slight design choice differences that make some people prefer it over newer alternatives), but I'm sure that can be simplified or streamlined (with enough effort, which I don't expect anybody to put in!) |
This file contains hidden or 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
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.
Replacing the existing
config.luadynamic approach for documentingtelescope.setup(opts)'soptsvalues to the---@classapproach.There's a somewhat complicated coupling and chain of inheritance between many of the fields, the base picker class and the many builtin pickers. Like how each builtin picker (and extension pickers) inherit many but not all of the
defaultoptions (egvimgrep_argumentsare for only a couple builtins) which share many but not all the base picker options. Many of the base picker options are yet to be documented. And then some options are "config-only", and not passable to pickers at invocation time (egthemeandmappings).telescope.setup.pickersin the current form. worth keeping?telescope.builtin.base_optsset bypickers>defaultsconfig.lua, dropping existing descriptions, the---@evalcall based on it