diff --git a/doc/pending.txt b/doc/pending.txt index f8c61a9..cc4f00d 100644 --- a/doc/pending.txt +++ b/doc/pending.txt @@ -238,7 +238,7 @@ COMMANDS *pending-commands* *:Pending-undo* :Pending undo Undo the last `:w` save, restoring the task store to its previous state. - Equivalent to the `U` buffer-local key (see |pending-mappings|). Up to 20 + Equivalent to the `gz` buffer-local key (see |pending-mappings|). Up to 20 levels of undo are persisted across sessions. *:Pending-init* @@ -267,11 +267,11 @@ Default buffer-local keys: ~ ------- ------------------------------------------------ `q` Close the task buffer (`close`) `` Toggle complete / uncomplete (`toggle`) - `!` Toggle the priority flag (`priority`) - `D` Prompt for a due date (`date`) - `F` Prompt for filter predicates (`filter`) + `g!` Toggle the priority flag (`priority`) + `gd` Prompt for a due date (`date`) + `gf` Prompt for filter predicates (`filter`) `` Switch between category / queue view (`view`) - `U` Undo the last `:w` save (`undo`) + `gz` Undo the last `:w` save (`undo`) `o` Insert a new task line below (`open_line`) `O` Insert a new task line above (`open_line_above`) `zc` Fold the current category section (requires `folding`) @@ -307,6 +307,23 @@ All motions support count: `3]]` jumps three headers forward. `]]` and `dd`, `p`, `P`, and `:w` work as standard Vim operations. +Deprecated keys: ~ *pending-deprecated-keys* +The following keys were renamed to avoid shadowing Vim builtins. The old +keys still work but emit a deprecation warning and will be removed in a +future release: + + Old New Action ~ + ------- ------- ------------------------------------------------ + `!` `g!` Toggle the priority flag + `D` `gd` Prompt for a due date + `F` `gf` Prompt for filter predicates + `U` `gz` Undo the last `:w` save + +To silence warnings, set the new keys explicitly in your config or set the +old keys to `false`: >lua + vim.g.pending = { keymaps = { priority = 'g!' } } +< + *(pending-open)* (pending-open) Open the task buffer. Maps to |:Pending| with no arguments. @@ -607,10 +624,10 @@ loads: >lua close = 'q', toggle = '', view = '', - priority = '!', - date = 'D', - undo = 'U', - filter = 'F', + priority = 'g!', + date = 'gd', + undo = 'gz', + filter = 'gf', open_line = 'o', open_line_above = 'O', a_task = 'at',