From unknown Tue Sep 09 02:38:29 2025 X-Loop: help-debbugs@gnu.org Subject: bug#71132: Documentation patch Resent-From: Jeremy Bryant Original-Sender: "Debbugs-submit" Resent-CC: bug-auctex@gnu.org Resent-Date: Wed, 22 May 2024 21:33:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 71132 X-GNU-PR-Package: auctex X-GNU-PR-Keywords: To: 71132@debbugs.gnu.org Cc: Arash Esbati X-Debbugs-Original-To: bug-auctex@gnu.org Received: via spool by submit@debbugs.gnu.org id=B.17164135447969 (code B ref -1); Wed, 22 May 2024 21:33:01 +0000 Received: (at submit) by debbugs.gnu.org; 22 May 2024 21:32:24 +0000 Received: from localhost ([127.0.0.1]:58013 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1s9tZP-00024T-L0 for submit@debbugs.gnu.org; Wed, 22 May 2024 17:32:23 -0400 Received: from lists.gnu.org ([209.51.188.17]:52810) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1s9tZK-00024N-IF for submit@debbugs.gnu.org; Wed, 22 May 2024 17:32:22 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1s9tZC-00089s-J4 for bug-auctex@gnu.org; Wed, 22 May 2024 17:32:10 -0400 Received: from out-175.mta0.migadu.com ([2001:41d0:1004:224b::af]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1s9tZA-0003KR-2W for bug-auctex@gnu.org; Wed, 22 May 2024 17:32:10 -0400 X-Envelope-To: arash@gnu.org DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=jeremybryant.net; s=key1; t=1716413524; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type; bh=sy31QrNTUvvlfHKlYK3LkZEPyqq0NH1Js8WA9F0lqRY=; b=uiJe9BM1MO494Arw2om4WOIIPWu5ZHj8A+kqrd2ygPR7ts+603cJTMwIUs0w2I5z4lhCwY r/g81sR6WbBcB0+L/rZLNVZAo6FF2cT0TZf8GMl5XRLDRQ0dGoYEoq8bOscce4pic9Q3ha Eny9+3DN25StojDamJ8gJIzX16QjKQ4UByf2BtA4QXFTygzknIYuVKfkzF41hucKfpDyR6 3ARC/uZ5oZwfhmfZbpOlqE+idQQ9r+6nJArf3u7cVOocQKzRyskAcYQEIxJEXqVfJfgGjH c229XTLhXD3qkCrlancxnb/LDAJFYmwUhx2zYgxt+WZzriol9cwU/ClGk/KAVQ== X-Envelope-To: bug-auctex@gnu.org X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. From: Jeremy Bryant Date: Wed, 22 May 2024 22:32:01 +0100 Message-ID: <87ttipy1m6.fsf@jeremybryant.net> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Migadu-Flow: FLOW_OUT Received-SPF: pass client-ip=2001:41d0:1004:224b::af; envelope-from=jb@jeremybryant.net; helo=out-175.mta0.migadu.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-Spam-Score: -1.4 (-) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -2.4 (--) --=-=-= Content-Type: text/plain Please find attached a documentation patch for consideration. This implements some suggestions from M-x checkdoc. Any feedback welcome. Jeremy --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0001-Checkdoc-improvements.patch >From 321a84b9373e3b7d8eb823ca3dfba96b7eef38bf Mon Sep 17 00:00:00 2001 From: Jeremy Bryant 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 --=-=-=-- From unknown Tue Sep 09 02:38:29 2025 X-Loop: help-debbugs@gnu.org Subject: bug#71132: Documentation patch Resent-From: Arash Esbati Original-Sender: "Debbugs-submit" Resent-CC: bug-auctex@gnu.org Resent-Date: Fri, 24 May 2024 07:56:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 71132 X-GNU-PR-Package: auctex X-GNU-PR-Keywords: To: 71132@debbugs.gnu.org Cc: Jeremy Bryant , 71132-done@debbugs.gnu.org X-Debbugs-Original-To: Jeremy Bryant via bug-auctex via Bug reporting list for AUCTeX Received: via spool by submit@debbugs.gnu.org id=B.171653734419816 (code B ref -1); Fri, 24 May 2024 07:56:01 +0000 Received: (at submit) by debbugs.gnu.org; 24 May 2024 07:55:44 +0000 Received: from localhost ([127.0.0.1]:35619 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sAPmC-00059Y-Ew for submit@debbugs.gnu.org; Fri, 24 May 2024 03:55:44 -0400 Received: from lists.gnu.org ([209.51.188.17]:58916) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sAPm9-00059S-UO for submit@debbugs.gnu.org; Fri, 24 May 2024 03:55:43 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1sAPm2-0003Pk-Qf for bug-auctex@gnu.org; Fri, 24 May 2024 03:55:34 -0400 Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1sAPm2-00060L-IG; Fri, 24 May 2024 03:55:34 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=MIME-Version:Date:References:In-Reply-To:Subject:To: From; bh=XCDMXTqTBmN4YAFD0pazlyIWxiNFs9TcGkD7ljNl9Es=; b=fgs33Y9Uh/aL69Lx4lKQ SYqk7wjwagJ7pudlWSUV+w59SlJ4gDApRordFMVufnXgsDB/D45fg88VyR/CYtjuqV4n4mWnoRCTH X9q8GOALEhsBxm5rDBIL0h/EtSHxfZYlCWvu+Ic4AcvTCATfqju682KEpryjUPchiG5ZK553flkji /Tjy+h48/rBowNsTSslHTOEuxnKnkR9tI8jVfkdjqi1femPI9ZL2X8CiEjzl/5DEJ6J1BinmuUvKZ sUhLWgx8k3QOUKlgQdCtOutrpviVJrsGTepBAd1vm+XcVgVoLJ2yUID+o0wTnOZ4KSaPr7Ha4a8rj nHUd6AIUbeOq3g==; From: Arash Esbati In-Reply-To: <87ttipy1m6.fsf@jeremybryant.net> (Jeremy Bryant via bug-auctex via Bug reporting list for AUCTeX's message of "Wed, 22 May 2024 22:32:01 +0100") References: <87ttipy1m6.fsf@jeremybryant.net> Date: Fri, 24 May 2024 09:55:08 +0200 Message-ID: User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: text/plain X-Spam-Score: -2.3 (--) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -3.3 (---) Jeremy Bryant via bug-auctex via Bug reporting list for AUCTeX 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 From unknown Tue Sep 09 02:38:29 2025 MIME-Version: 1.0 X-Mailer: MIME-tools 5.505 (Entity 5.505) X-Loop: help-debbugs@gnu.org From: help-debbugs@gnu.org (GNU bug Tracking System) To: Jeremy Bryant Subject: bug#71132: closed (Re: bug#71132: Documentation patch) Message-ID: References: <87ttipy1m6.fsf@jeremybryant.net> X-Gnu-PR-Message: they-closed 71132 X-Gnu-PR-Package: auctex Reply-To: 71132@debbugs.gnu.org Date: Fri, 24 May 2024 07:56:02 +0000 Content-Type: multipart/mixed; boundary="----------=_1716537362-19841-1" This is a multi-part message in MIME format... ------------=_1716537362-19841-1 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" 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 71132@debbugs.gnu.org. --=20 71132: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=3D71132 GNU Bug Tracking System Contact help-debbugs@gnu.org with problems ------------=_1716537362-19841-1 Content-Type: message/rfc822 Content-Disposition: inline Content-Transfer-Encoding: 7bit Received: (at 71132-done) by debbugs.gnu.org; 24 May 2024 07:55:49 +0000 Received: from localhost ([127.0.0.1]:35624 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sAPmG-00059k-Rg for submit@debbugs.gnu.org; Fri, 24 May 2024 03:55:49 -0400 Received: from eggs.gnu.org ([209.51.188.92]:45992) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sAPmE-00059R-MB for 71132-done@debbugs.gnu.org; Fri, 24 May 2024 03:55:46 -0400 Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1sAPm2-00060L-IG; Fri, 24 May 2024 03:55:34 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=MIME-Version:Date:References:In-Reply-To:Subject:To: From; bh=XCDMXTqTBmN4YAFD0pazlyIWxiNFs9TcGkD7ljNl9Es=; b=fgs33Y9Uh/aL69Lx4lKQ SYqk7wjwagJ7pudlWSUV+w59SlJ4gDApRordFMVufnXgsDB/D45fg88VyR/CYtjuqV4n4mWnoRCTH X9q8GOALEhsBxm5rDBIL0h/EtSHxfZYlCWvu+Ic4AcvTCATfqju682KEpryjUPchiG5ZK553flkji /Tjy+h48/rBowNsTSslHTOEuxnKnkR9tI8jVfkdjqi1femPI9ZL2X8CiEjzl/5DEJ6J1BinmuUvKZ sUhLWgx8k3QOUKlgQdCtOutrpviVJrsGTepBAd1vm+XcVgVoLJ2yUID+o0wTnOZ4KSaPr7Ha4a8rj nHUd6AIUbeOq3g==; From: Arash Esbati To: Jeremy Bryant via bug-auctex via Bug reporting list for AUCTeX Subject: Re: bug#71132: Documentation patch In-Reply-To: <87ttipy1m6.fsf@jeremybryant.net> (Jeremy Bryant via bug-auctex via Bug reporting list for AUCTeX's message of "Wed, 22 May 2024 22:32:01 +0100") References: <87ttipy1m6.fsf@jeremybryant.net> Date: Fri, 24 May 2024 09:55:08 +0200 Message-ID: User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: text/plain X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 71132-done Cc: Jeremy Bryant , 71132-done@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -3.3 (---) Jeremy Bryant via bug-auctex via Bug reporting list for AUCTeX 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 ------------=_1716537362-19841-1 Content-Type: message/rfc822 Content-Disposition: inline Content-Transfer-Encoding: 7bit Received: (at submit) by debbugs.gnu.org; 22 May 2024 21:32:24 +0000 Received: from localhost ([127.0.0.1]:58013 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1s9tZP-00024T-L0 for submit@debbugs.gnu.org; Wed, 22 May 2024 17:32:23 -0400 Received: from lists.gnu.org ([209.51.188.17]:52810) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1s9tZK-00024N-IF for submit@debbugs.gnu.org; Wed, 22 May 2024 17:32:22 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1s9tZC-00089s-J4 for bug-auctex@gnu.org; Wed, 22 May 2024 17:32:10 -0400 Received: from out-175.mta0.migadu.com ([2001:41d0:1004:224b::af]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1s9tZA-0003KR-2W for bug-auctex@gnu.org; Wed, 22 May 2024 17:32:10 -0400 X-Envelope-To: arash@gnu.org DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=jeremybryant.net; s=key1; t=1716413524; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type; bh=sy31QrNTUvvlfHKlYK3LkZEPyqq0NH1Js8WA9F0lqRY=; b=uiJe9BM1MO494Arw2om4WOIIPWu5ZHj8A+kqrd2ygPR7ts+603cJTMwIUs0w2I5z4lhCwY r/g81sR6WbBcB0+L/rZLNVZAo6FF2cT0TZf8GMl5XRLDRQ0dGoYEoq8bOscce4pic9Q3ha Eny9+3DN25StojDamJ8gJIzX16QjKQ4UByf2BtA4QXFTygzknIYuVKfkzF41hucKfpDyR6 3ARC/uZ5oZwfhmfZbpOlqE+idQQ9r+6nJArf3u7cVOocQKzRyskAcYQEIxJEXqVfJfgGjH c229XTLhXD3qkCrlancxnb/LDAJFYmwUhx2zYgxt+WZzriol9cwU/ClGk/KAVQ== X-Envelope-To: bug-auctex@gnu.org X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. From: Jeremy Bryant To: bug-auctex@gnu.org Subject: Documentation patch Date: Wed, 22 May 2024 22:32:01 +0100 Message-ID: <87ttipy1m6.fsf@jeremybryant.net> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Migadu-Flow: FLOW_OUT Received-SPF: pass client-ip=2001:41d0:1004:224b::af; envelope-from=jb@jeremybryant.net; helo=out-175.mta0.migadu.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-Spam-Score: -1.4 (-) X-Debbugs-Envelope-To: submit Cc: Arash Esbati X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -2.4 (--) --=-=-= Content-Type: text/plain Please find attached a documentation patch for consideration. This implements some suggestions from M-x checkdoc. Any feedback welcome. Jeremy --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0001-Checkdoc-improvements.patch >From 321a84b9373e3b7d8eb823ca3dfba96b7eef38bf Mon Sep 17 00:00:00 2001 From: Jeremy Bryant 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 --=-=-=-- ------------=_1716537362-19841-1--