branch: main
commit 9b89f12143bb59cb5e6b8bad914a2f031bccafdd
Author: Arash Esbati <[email protected]>
Commit: Arash Esbati <[email protected]>
; Improve docstring
* latex.el (LaTeX-imenu-create-index-function): Clarify docstring.
Issue reported by Mandar Mitra <[email protected]>:
https://lists.gnu.org/archive/html/auctex/2025-05/msg00000.html
---
latex.el | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/latex.el b/latex.el
index 797513f2..7f6b356f 100644
--- a/latex.el
+++ b/latex.el
@@ -9267,7 +9267,10 @@ function would return non-nil and `(match-string 1)'
would return
LaTeX-error-description-list))
(defun LaTeX-imenu-create-index-function ()
- "Imenu support function for LaTeX."
+ "Return an alist for Imenu support for LaTeX.
+The returned alist is built by the same facilities used for outline
+minor mode support. Hence, the value of `TeX-outline-extra' is
+respected."
(TeX-update-style)
(let (entries
(regexp (LaTeX-outline-regexp)))
