* font-lock.el (font-lock-value-in-major-mode): Doc fix
authorLars Ingebrigtsen <larsi@gnus.org>
Sun, 9 Feb 2014 03:25:19 +0000 (19:25 -0800)
committerLars Ingebrigtsen <larsi@gnus.org>
Sun, 9 Feb 2014 03:25:19 +0000 (19:25 -0800)
Clarify the meaning of the parameter.

Fixes: debbugs:12282

lisp/ChangeLog
lisp/font-lock.el

index 6e55544..91a85c9 100644 (file)
@@ -1,5 +1,8 @@
 2014-02-09  Lars Ingebrigtsen  <larsi@gnus.org>
 
+       * font-lock.el (font-lock-value-in-major-mode): Clarify the
+       meaning of the parameter (bug#12282).
+
        * files.el (find-file-noselect): Clarify prompt when changing
        readedness (bug#13261).
        (locate-file): Suffixes aren't returned, so don't say that they
index 7e9131d..11a8466 100644 (file)
@@ -1764,12 +1764,14 @@ If SYNTACTIC-KEYWORDS is non-nil, it means these keywords are used for
                                 (funcall keywords)
                               (eval keywords)))))
 
-(defun font-lock-value-in-major-mode (alist)
-  "Return value in ALIST for `major-mode', or ALIST if it is not an alist.
-Structure is ((MAJOR-MODE . VALUE) ...) where MAJOR-MODE may be t."
-  (if (consp alist)
-      (cdr (or (assq major-mode alist) (assq t alist)))
-    alist))
+(defun font-lock-value-in-major-mode (values)
+  "If VALUES is an list, use `major-mode' as a key and return the `assq' value.
+VALUES should then be an alist on the form ((MAJOR-MODE . VALUE) ...) where
+MAJOR-MODE may be t.
+If VALUES isn't a list, return VALUES."
+  (if (consp values)
+      (cdr (or (assq major-mode values) (assq t values)))
+    values))
 
 (defun font-lock-choose-keywords (keywords level)
   "Return LEVELth element of KEYWORDS.