Subject: bug#71132: closed (Re: bug#71132: Documentation patch)

From: [email-masked] (GNU bug Tracking System)
Date: Fri, 24 May 2024 07:56:02 +0000

Your bug report

#71132: Documentation patch

which was filed against the auctex package, has been closed.

The explanation is attached below, along with your original report.
If you require more details, please reply to [email-masked].

-- 
71132: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=71132
GNU Bug Tracking System
Contact [email-masked] with problems

Subject: Re: bug#71132: Documentation patch
From: Arash Esbati <[email-masked]>
To: Jeremy Bryant via bug-auctex via Bug reporting list for AUCTeX <[email-masked]>
Cc: Jeremy Bryant <[email-masked]>, [email-masked]
Date: Fri, 24 May 2024 09:55:08 +0200
List-Id: <debbugs-submit.debbugs.gnu.org>

Jeremy Bryant via bug-auctex via Bug reporting list for AUCTeX <[email-masked]> writes:

> Please find attached a documentation patch for consideration.  This
> implements some suggestions from M-x checkdoc.

Thanks, installed, and closing.

> Any feedback welcome.

It is not necessary to CC me, sending messages to the tracker is
sufficient since others can pick up the installation as well.

Best, Arash

Subject: Documentation patch
From: Jeremy Bryant <[email-masked]>
To: [email-masked]
Cc: Arash Esbati <[email-masked]>
Date: Wed, 22 May 2024 22:32:01 +0100
List-Id: <debbugs-submit.debbugs.gnu.org>

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-masked]>
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