From: Eli Zaretskii <eliz@gnu.org>
Date: Sat, 30 Jun 2018 09:22:05 +0000 (+0300)
Subject: Minor improvements in documentation of imenu.el
X-Git-Tag: emacs-26.1.90~309
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=c80f31f591685203162f8fc44fd0f1b98332866a;p=emacs.git

Minor improvements in documentation of imenu.el

* lisp/imenu.el (imenu-generic-skip-comments-and-strings)
(imenu--generic-function): Doc fixes.  (Bug#31962)
---

diff --git a/lisp/imenu.el b/lisp/imenu.el
index f56e7b50396..8cf3c768ead 100644
--- a/lisp/imenu.el
+++ b/lisp/imenu.el
@@ -187,7 +187,9 @@ with name concatenation."
 
 (defcustom imenu-generic-skip-comments-and-strings t
   "When non-nil, ignore text inside comments and strings.
-Only affects `imenu--generic-function'."
+Only affects `imenu-default-create-index-function' (and any
+alternative implementation of `imenu-create-index-function' that
+uses `imenu--generic-function')."
   :type 'boolean
   :group 'imenu
   :version "24.4")
@@ -738,7 +740,7 @@ for modes which use `imenu--generic-function'.  If it is not set, but
 ;; so it needs to be careful never to loop!
 (defun imenu--generic-function (patterns)
   "Return an index alist of the current buffer based on PATTERNS.
-PATTERNS should be an alist with the same form as `imenu-generic-expression'.
+PATTERNS should be an alist of the same form as `imenu-generic-expression'.
 
 If `imenu-generic-skip-comments-and-strings' is non-nil, this ignores
 text inside comments and strings.