Fix option field type

notomo · Aug 10, 2023 · 83e4408 · 83e4408
1 parent 2fb5b73
commit 83e4408
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 10 deletions.
diff --git a/doc/waitevent.nvim.txt b/doc/waitevent.nvim.txt
@@ -32,11 +32,11 @@ WaiteventOpenContext                                    *WaiteventOpenContext*
 
 WaiteventEditorOption                                  *WaiteventEditorOption*
 
-- {open} (fun(ctx:WaiteventOpenContext,...:string)) function that be called to open files
-- {done_events} (string[]) autocmd events that treated as done
-- {on_done} (fun(ctx:WaiteventContext)) function that called on done editor. |WaiteventContext|
-- {cancel_events} (string[]) autocmd events that treated as cancel
-- {on_canceled} (fun(ctx:WaiteventContext)) function that called on canceled editor. |WaiteventContext|
+- {open} (fun(ctx:WaiteventOpenContext,...:string)?) function that be called to open files
+- {done_events} (string[]?) autocmd events that treated as done
+- {on_done} (fun(ctx:WaiteventContext)?) function that called on done editor. |WaiteventContext|
+- {cancel_events} (string[]?) autocmd events that treated as cancel
+- {on_canceled} (fun(ctx:WaiteventContext)?) function that called on canceled editor. |WaiteventContext|
 
 WaiteventContext                                            *WaiteventContext*
 

diff --git a/lua/waitevent/init.lua b/lua/waitevent/init.lua
@@ -7,11 +7,11 @@ local M = {}
 --- @field stdin string if stdin exists, it is not empty. |--|
 
 --- @class WaiteventEditorOption
---- @field open fun(ctx:WaiteventOpenContext,...:string) function that be called to open files
---- @field done_events string[] autocmd events that treated as done
---- @field on_done fun(ctx:WaiteventContext) function that called on done editor. |WaiteventContext|
---- @field cancel_events string[] autocmd events that treated as cancel
---- @field on_canceled fun(ctx:WaiteventContext) function that called on canceled editor. |WaiteventContext|
+--- @field open fun(ctx:WaiteventOpenContext,...:string)? function that be called to open files
+--- @field done_events string[]? autocmd events that treated as done
+--- @field on_done fun(ctx:WaiteventContext)? function that called on done editor. |WaiteventContext|
+--- @field cancel_events string[]? autocmd events that treated as cancel
+--- @field on_canceled fun(ctx:WaiteventContext)? function that called on canceled editor. |WaiteventContext|
 
 --- @class WaiteventContext
 --- @field window_id_before_open integer: |window-ID| before |WaiteventEditorOption|.open