avy.el (avy--read-candidates): Fix docstring

Don't quote key bindings.
This patch was applied in GNU ELPA earlier.
This commit is contained in:
Oleh Krehel 2019-05-11 16:00:29 +02:00
parent b408f76e3d
commit 0e59474430

9
avy.el
View File

@ -1975,11 +1975,10 @@ newline."
(defun avy--read-candidates (&optional re-builder)
"Read as many chars as possible and return their occurrences.
At least one char must be read, and then repeatedly one next char
may be read if it is entered before `avy-timeout-seconds'. Any
key defined in `avy-del-last-char-by' (by default `C-h' and `DEL')
deletes the last char entered, and `RET' exits with the
currently read string immediately instead of waiting for another
char for `avy-timeout-seconds'.
may be read if it is entered before `avy-timeout-seconds'. DEL
deletes the last char entered, and RET exits with the currently
read string immediately instead of waiting for another char for
`avy-timeout-seconds'.
The format of the result is the same as that of `avy--regex-candidates'.
This function obeys `avy-all-windows' setting.
RE-BUILDER is a function that takes a string and returns a regex.