docs: added keybinding documentation to all list type prompts. Closes

kazhala · Nov 29, 2021 · e748d21 · e748d21
1 parent 745fb15
commit e748d21
Show file tree

Hide file tree

Showing 5 changed files with 77 additions and 13 deletions.
diff --git a/docs/pages/prompts/checkbox.md b/docs/pages/prompts/checkbox.md
@@ -48,10 +48,23 @@ choices = [
 ## Keybindings
 
 ```{seealso}
-{ref}`pages/prompts/list:Keybindings`
+{ref}`pages/kb:Keybindings`
 ```
 
-This prompt shares the same keybindings as {ref}`select prompt <pages/prompts/list:keybindings>`.
+```{include} ../kb.md
+:start-after: <!-- start kb -->
+:end-before: <!-- end kb -->
+```
+
+```{include} ./list.md
+:start-after: <!-- start list kb -->
+:end-before: <!-- end list kb -->
+```
+
+```{include} ./list.md
+:start-after: <!-- start list vi kb -->
+:end-before: <!-- end list vi kb -->
+```
 
 ## Default Value
 

diff --git a/docs/pages/prompts/expand.md b/docs/pages/prompts/expand.md
@@ -69,11 +69,28 @@ choices = [
 ## Keybindings
 
 ```{seealso}
-{ref}`pages/prompts/list:keybindings`
+{ref}`pages/kb:Keybindings`
 ```
 
-In addition to the keybindings mentioned in {ref}`select prompt <pages/prompts/list:keybindings>`, keybindings are created for all the
-`key` specified for each choice which you can use to jump the target choice.
+```{hint}
+In addition to the keybindings mentioned below, keybindings are created for all the `key` specified for each choice which you can
+use to jump to the target choce.
+```
+
+```{include} ../kb.md
+:start-after: <!-- start kb -->
+:end-before: <!-- end kb -->
+```
+
+```{include} ./list.md
+:start-after: <!-- start list kb -->
+:end-before: <!-- end list kb -->
+```
+
+```{include} ./list.md
+:start-after: <!-- start list vi kb -->
+:end-before: <!-- end list vi kb -->
+```
 
 ## Multiple Selection
 

diff --git a/docs/pages/prompts/fuzzy.md b/docs/pages/prompts/fuzzy.md
@@ -43,15 +43,25 @@ This prompt does not accepts choices containing {ref}`pages/separator:Separator`
 ## Keybindings
 
 ```{seealso}
-{ref}`pages/prompts/list:keybindings`
+{ref}`pages/kb:Keybindings`
 ```
 
-This prompt shares the same keybindings as {ref}`select prompt <pages/prompts/list:keybindings>`.
-
-However it does not enable `j/k` navigation when `vi_mode` is True.
-When `vi_mode` is True in fuzzy prompt, the input buffer will become vim input mode, no other keybindings are altered.
+```{hint}
+This prompt does not enable `j/k` navigation when `vi_mode` is `True`. When `vi_mode` is `True` in fuzzy prompt, the input buffer
+will become vim input mode, no other keybindings are altered.
 
 The `space` key for toggle choice is also disabled since it blocks user from typing space in the input buffer.
+```
+
+```{include} ../kb.md
+:start-after: <!-- start kb -->
+:end-before: <!-- end kb -->
+```
+
+```{include} ./list.md
+:start-after: <!-- start list kb -->
+:end-before: <!-- end list kb -->
+```
 
 ## Multiple Selection
 

diff --git a/docs/pages/prompts/list.md b/docs/pages/prompts/list.md
@@ -43,6 +43,8 @@ A prompt that displays a list of choices to select.
 :end-before: <!-- end kb -->
 ```
 
+<!-- start list kb -->
+
 The following dictionary contains the additional keybindings created by this prompt.
 
 ```{code-block} python
@@ -76,6 +78,10 @@ The following dictionary contains the additional keybindings created by this pro
 }
 ```
 
+<!-- end list kb -->
+
+<!-- start list vi kb -->
+
 When `vi_mode` is True, the "up" and "down" navigation key will be changed.
 
 ```{code-block} python
@@ -91,6 +97,8 @@ When `vi_mode` is True, the "up" and "down" navigation key will be changed.
 }
 ```
 
+<!-- end list vi kb -->
+
 ## Multiple Selection
 
 ```{seealso}

diff --git a/docs/pages/prompts/rawlist.md b/docs/pages/prompts/rawlist.md
@@ -37,11 +37,27 @@ For this specific prompt, due to the shortcut being created is between 1-9, the
 ## Keybindings
 
 ```{seealso}
-{ref}`pages/prompts/list:keybindings`
+{ref}`pages/kb:Keybindings`
 ```
 
-In addition to the keybindings mentioned in {ref}`select prompt <pages/prompts/list:keybindings>`, keybindings are created for keys 1-9
-to jump to the target index choices.
+```{hint}
+In addition to the keybindings mentioned below, keybindings are created for keys 1-9 to jump to the target index choices.
+```
+
+```{include} ../kb.md
+:start-after: <!-- start kb -->
+:end-before: <!-- end kb -->
+```
+
+```{include} ./list.md
+:start-after: <!-- start list kb -->
+:end-before: <!-- end list kb -->
+```
+
+```{include} ./list.md
+:start-after: <!-- start list vi kb -->
+:end-before: <!-- end list vi kb -->
+```
 
 ## Multiple Selection