docs: functions in entry_manager.lua, pickers.lua and linked_list.lua
#927
Conversation
l-kershaw
force-pushed
the
picker_docs
branch
2 times, most recently
from
50d05eb
to
71e3b88
Compare
l-kershaw
changed the title
entry_manager.lua and in pickers.luaentry_manager.lua, pickers.lua and linked_list.lua
|
|
||
| --- Create a new linked list | ||
| ---@param opts table | ||
| --- @key track_at number: the index of the node to track |
There was a problem hiding this comment.
@key is currently not a thing, but that also doesn't matter because right now we are not exporting documentation for this file
There was a problem hiding this comment.
That's fine, was just matching what had been done elsewhere
| ---@param status table: table containing information on the picker | ||
| --- and associated windows. Generally obtained from `state.get_status` |
There was a problem hiding this comment.
fyi there is currently no multiline annotations (doesnt matter as long as we do not generate docs from it)
| -- TODO: document what the purpose of this is | ||
| -- Currently only used in `Picker: get_result_completor` |
There was a problem hiding this comment.
completion callbacks can be registered via opts.on_complete basically functions that run after all items are proceeded once. Currently used in testing, but users could do anything with it.
and _on_complete is basically only calling all these registered callbacks
|
This is mostly good but you always have to ask @tjdevries if you are working with systems that low level. He did wrote EVERYTHING here i also only read the code 😆 This is probably another good point to mention. I still want to move linked list into plenary (as mentioned here as well #293 (comment)) plenary.collections is currently a little "empty" 😆 |
skip-checks: true
This is a partial revert of commit 846e0ee.
|
Closing in favour of #1554, as this PR is so out of date that the merge conflicts would be more trouble than its worth 😅 |
Adds documentation for functions in
entry_manager.luaand inpickers.lua.Was having a think about how to implement scrolling of results (as discussed in #42) and realised I did not understand the purpose of most of the functions in these files. This PR is the result of me trying to figure this out.
(It is also hopefully a way for me to be told where I have misunderstood things 🤣)
TODO:
pickers.lualinked_list.lua