document dynamic/async completion #1123
Replies: 2 comments 3 replies
-
|
For now you can take a look at the source of Neither the async nor the dynamic API are well documented. This APIs are also private. It may make sense to change this at some point, making the underlying completion APIs public or factoring them out. |
Beta Was this translation helpful? Give feedback.
-
|
thanks for your response. yeah, i figured it is worth documenting somehow and/or making public, as it is also its stated raison d'etre, as per its docstring: "You should use completing-read instead of consult--read if you don't use asynchronous candidate computation or candidate preview." |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
-
it'd be nice if there were some documentation of how to dynamically generate candidates for
consult--read, for package authors using consult.it's referred to as both async and dynamic, its not clear if there is a difference?
i couldn't find any mention of
consult--dynamic-completionin the readme or the wiki. and its docstring is terse.meanwhile the in-built consult async functions seem focused on CLI cmds, which was not my use case.
i had to read the code of an external package that uses consult to work out what to do.
Beta Was this translation helpful? Give feedback.
All reactions