docs(pick): add note that target window is set as current after stop()

echasnovski · Dec 26, 2024 · f3531a7 · f3531a7
1 parent 84ade0b
commit f3531a7
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/doc/mini-pick.txt b/doc/mini-pick.txt
@@ -834,6 +834,7 @@ Notes:
 - If there is currently an active picker, it is properly stopped and new one
   is started "soon" in the main event-loop (see |vim.schedule()|).
 - Current window at the moment of this function call is treated as "target".
+  It will be set back as current after |MiniPick.stop()|.
   See |MiniPick.get_picker_state()| and |MiniPick.set_picker_target_window()|.
 
 Parameters ~

diff --git a/lua/mini/pick.lua b/lua/mini/pick.lua
@@ -864,6 +864,7 @@ MiniPick.config = {
 --- - If there is currently an active picker, it is properly stopped and new one
 ---   is started "soon" in the main event-loop (see |vim.schedule()|).
 --- - Current window at the moment of this function call is treated as "target".
+---   It will be set back as current after |MiniPick.stop()|.
 ---   See |MiniPick.get_picker_state()| and |MiniPick.set_picker_target_window()|.
 ---
 ---@param opts table|nil Options. Should have same structure as |MiniPick.config|.