]> code.delx.au - gnu-emacs-elpa/commitdiff
Fix yas-key-syntaxes example functions docstrings.
authorNoam Postavsky <npostavs@users.sourceforge.net>
Sun, 10 Aug 2014 17:13:45 +0000 (13:13 -0400)
committerNoam Postavsky <npostavs@users.sourceforge.net>
Sun, 10 Aug 2014 18:05:26 +0000 (14:05 -0400)
* yasnippet.el (yas-try-key-from-whitespace),
  (yas-shortest-key-until-whitespace),
  (yas-longest-key-from-whitespace): docstring describes the effect, not
  implementation.

yasnippet.el

index dcf6bf0575e3b409cd666b568199e781e046163f..900d3267f489dc33862b659aa96f3c858810014c 100644 (file)
@@ -2730,28 +2730,22 @@ and `kill-buffer' instead."
 ;;; User convenience functions, for using in `yas-key-syntaxes'
 
 (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
-marks it as something else (typically comment ender). Use as
-element of `yas-key-syntaxes'."
+marks it as something else (typically comment ender)."
   (skip-chars-backward "^[:space:]\n"))
 
 (defun yas-shortest-key-until-whitespace (_start-point)
-  "Return `again' until at whitespace.
-
-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'."
+  "Like `yas-longest-key-from-whitespace' but take the shortest key."
   (when (/= (skip-chars-backward "^[:space:]\n" (1- (point))) 0)
     'again))
 
 (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
-marks it as something else (typically comment ender). Use as
-element of `yas-key-syntaxes'."
+marks it as something else (typically comment ender)."
   (if (= (point) start-point)
       (yas-try-key-from-whitespace start-point)
     (forward-char))