Fix yas-key-syntaxes example functions docstrings.

* yasnippet.el (yas-try-key-from-whitespace),
  (yas-shortest-key-until-whitespace),
  (yas-longest-key-from-whitespace): docstring describes the effect, not
  implementation.
This commit is contained in:
Noam Postavsky 2014-08-10 13:13:45 -04:00
parent 5d10b5dfee
commit 47a3d5f1cb

View File

@ -2730,28 +2730,22 @@ and `kill-buffer' instead."
;;; User convenience functions, for using in `yas-key-syntaxes' ;;; User convenience functions, for using in `yas-key-syntaxes'
(defun yas-try-key-from-whitespace (_start-point) (defun yas-try-key-from-whitespace (_start-point)
"Go back to nearest whitespace. "As `yas-key-syntaxes' element, look for whitespace delimited key.
A newline will be considered whitespace even if the mode syntax A newline will be considered whitespace even if the mode syntax
marks it as something else (typically comment ender). Use as marks it as something else (typically comment ender)."
element of `yas-key-syntaxes'."
(skip-chars-backward "^[:space:]\n")) (skip-chars-backward "^[:space:]\n"))
(defun yas-shortest-key-until-whitespace (_start-point) (defun yas-shortest-key-until-whitespace (_start-point)
"Return `again' until at whitespace. "Like `yas-longest-key-from-whitespace' but take the shortest key."
A newline will be considered whitespace even if the mode syntax
marks it as something else (typically comment ender). Use as
element of `yas-key-syntaxes'."
(when (/= (skip-chars-backward "^[:space:]\n" (1- (point))) 0) (when (/= (skip-chars-backward "^[:space:]\n" (1- (point))) 0)
'again)) 'again))
(defun yas-longest-key-from-whitespace (start-point) (defun yas-longest-key-from-whitespace (start-point)
"Go back to nearest whitespace, then go forward and return `again' until at START-POINT. "As `yas-key-syntaxes' element, look for longest key between point and whitespace.
A newline will be considered whitespace even if the mode syntax A newline will be considered whitespace even if the mode syntax
marks it as something else (typically comment ender). Use as marks it as something else (typically comment ender)."
element of `yas-key-syntaxes'."
(if (= (point) start-point) (if (= (point) start-point)
(yas-try-key-from-whitespace start-point) (yas-try-key-from-whitespace start-point)
(forward-char)) (forward-char))