Please find attached a documentation patch for consideration. This implements some suggestions from M-x checkdoc.
Any feedback welcome. Jeremy
>From 321a84b9373e3b7d8eb823ca3dfba96b7eef38bf Mon Sep 17 00:00:00 2001 From: Jeremy Bryant <[email protected]> Date: Wed, 22 May 2024 22:26:13 +0100 Subject: [PATCH] Checkdoc improvements * tex.el (TeX-engine-in-engine-alist): capitalize argument. (TeX-source-correlate-start-server-flag): follow Non-nil convention. --- tex.el | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tex.el b/tex.el index 503a54b3..0795e602 100644 --- a/tex.el +++ b/tex.el @@ -1621,7 +1621,7 @@ where an entry with the same car exists in the user-defined part." (TeX-delete-dups-by-car (append TeX-engine-alist TeX-engine-alist-builtin))) (defun TeX-engine-in-engine-alist (engine) - "Return the `engine' entry in `TeX-engine-alist'. + "Return entry ENGINE in `TeX-engine-alist'. Throw an error if `engine' is not present in the alist." (or @@ -1723,7 +1723,7 @@ as a string.") "Keep track if question about server start search was asked.") (defvar TeX-source-correlate-start-server-flag nil - "If non-nil, `TeX-source-correlate-start-server-maybe' will start a server. + "Non-nil means `TeX-source-correlate-start-server-maybe' will start a server. Code related to features requiring a server, for example, for inverse search, can set the variable.") -- 2.42.0
_______________________________________________ bug-auctex mailing list [email protected] https://lists.gnu.org/mailman/listinfo/bug-auctex
