summary refs log tree commit diff
diff options
context:
space:
mode:
authorDaniel Shahaf <d.s@daniel.shahaf.name>2016-11-19 12:21:19 +0000
committerDaniel Shahaf <d.s@daniel.shahaf.name>2016-11-20 05:34:21 +0000
commit968a59bfd0dd0b35aa82ac8fe86af65a5456baa7 (patch)
tree64c11961e5832a769434b779180f1ec53ecfff10
parentdf8d219da3e660a5721f25615f2d6d55c96690dc (diff)
downloadzsh-968a59bfd0dd0b35aa82ac8fe86af65a5456baa7.tar.gz
zsh-968a59bfd0dd0b35aa82ac8fe86af65a5456baa7.tar.xz
zsh-968a59bfd0dd0b35aa82ac8fe86af65a5456baa7.zip
39985: Document the [nyae] answers to the spelling correction prompt, $SPROMPT.
-rw-r--r--ChangeLog5
-rw-r--r--Doc/Zsh/params.yo8
2 files changed, 13 insertions, 0 deletions
diff --git a/ChangeLog b/ChangeLog
index 9415eefae..01a9d2cf9 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2016-11-20  Daniel Shahaf  <d.s@daniel.shahaf.name>
+
+	* 39985: Doc/Zsh/params.yo: Document the [nyae] answers to the
+	spelling correction prompt, $SPROMPT.
+
 2016-11-18  Daniel Shahaf  <d.s@daniel.shahaf.name>
 
 	* 39916 + 39930 + tweak: Completion/Unix/Command/_git: Complete
diff --git a/Doc/Zsh/params.yo b/Doc/Zsh/params.yo
index c7d84b9a8..0db8a1c0e 100644
--- a/Doc/Zsh/params.yo
+++ b/Doc/Zsh/params.yo
@@ -1458,6 +1458,14 @@ The prompt used for spelling correction.  The sequence
 `tt(%R)' expands to the string which presumably needs spelling
 correction, and `tt(%r)' expands to the proposed correction.
 All other prompt escapes are also allowed.
+
+The actions available at the prompt are tt([nyae]):
+startsitem()
+sitem(tt(n) +LPAR()`no'+RPAR() +LPAR()default+RPAR())(Discard the correction and run the command.)
+sitem(tt(y) +LPAR()`yes'+RPAR())(Make the correction and run the command.)
+sitem(tt(a) +LPAR()`abort'+RPAR())(Discard the entire command line without running it.)
+sitem(tt(e) +LPAR()`edit'+RPAR())(Resume editing the command line.)
+endsitem()
 )
 vindex(STTY)
 item(tt(STTY))(