From unknown Thu Jun 19 14:06:50 2025 X-Loop: help-debbugs@gnu.org Subject: bug#71215: PATCH for docstrings Resent-From: Jeremy Bryant Original-Sender: "Debbugs-submit" Resent-CC: bug-auctex@gnu.org Resent-Date: Sun, 26 May 2024 20:12:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 71215 X-GNU-PR-Package: auctex X-GNU-PR-Keywords: To: 71215@debbugs.gnu.org X-Debbugs-Original-To: bug-auctex@gnu.org Received: via spool by submit@debbugs.gnu.org id=B.171675429611966 (code B ref -1); Sun, 26 May 2024 20:12:01 +0000 Received: (at submit) by debbugs.gnu.org; 26 May 2024 20:11:36 +0000 Received: from localhost ([127.0.0.1]:42626 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sBKDQ-00036w-9l for submit@debbugs.gnu.org; Sun, 26 May 2024 16:11:36 -0400 Received: from lists.gnu.org ([209.51.188.17]:41574) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sBKDN-00036g-Cr for submit@debbugs.gnu.org; Sun, 26 May 2024 16:11:34 -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 1sBKDE-0004kM-GX for bug-auctex@gnu.org; Sun, 26 May 2024 16:11:24 -0400 Received: from out-174.mta1.migadu.com ([2001:41d0:203:375::ae]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1sBKDC-0005KP-In for bug-auctex@gnu.org; Sun, 26 May 2024 16:11:24 -0400 X-Envelope-To: bug-auctex@gnu.org DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=jeremybryant.net; s=key1; t=1716754274; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type; bh=rU3GPEUrJbRnnAjxqktLIeSvaJ5x23uH8B/eurkGX+o=; b=FE4/dp/B9+v9fI2omgXON0RWePVtFwDkZsWvLasTgVj3Zfxedc2TpSY8LxVXvFsxsKlGIm 51CXSSe5nibTQfu+oTERVYIBKbKIXh4u7lFgrVOgYV6Y7HYWQLrYRM6KaKQWp00Wno8gSb whhkMeeYZ3R5VG36jq96lScQBU5xyo+xfT9714PJOD2eAwi/ApEJiAP5C/jmusXLzYpso3 bUaIExi3ORQQ69JhkTA9H4NsovkmvOqlCksQZmoC/b89LYHgrYJwZUsaZypa/Zqoq7OV6/ qKTeRKP/Br+OzpdrwvVfHiks9mJeT3j+6ZxCKh6FEUTP8P2zKbpvquHnYvu/sQ== X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. From: Jeremy Bryant Date: Sun, 26 May 2024 21:11:02 +0100 Message-ID: <874jakmizt.fsf@jeremybryant.net> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Migadu-Flow: FLOW_OUT Received-SPF: pass client-ip=2001:41d0:203:375::ae; envelope-from=jb@jeremybryant.net; helo=out-174.mta1.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, T_SCC_BODY_TEXT_LINE=-0.01 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 Hi, This is a patch to improve docstrings in interactive functions from M-x checkdoc fixes. --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0001-Improve-documentation-for-interactive-functions-Chec.patch >From 02919173dd5351eefd20119c457a24255a5b2ec7 Mon Sep 17 00:00:00 2001 From: Jeremy Bryant Date: Sun, 26 May 2024 21:04:51 +0100 Subject: [PATCH] Improve documentation for interactive functions (Checkdoc fixes) * latex.el (LaTeX-environment): Correct docstring for required arg. (LaTeX-close-environment, LaTeX-fill-paragraph) (LaTeX-fill-environment, LaTeX-fill-section) (LaTeX-fill-buffer): Capitalize argument. --- latex.el | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/latex.el b/latex.el index baedfdc8..e0c90712 100644 --- a/latex.el +++ b/latex.el @@ -583,7 +583,7 @@ Styles such as tabularx may set it according to their needs.") (defun LaTeX-environment (arg) "Make LaTeX environment (\\begin{...}-\\end{...} pair). -With optional ARG, modify current environment. +With prefix ARG, modify current environment. It may be customized with the following variables: @@ -652,7 +652,7 @@ It may be customized with the following variables: (defun LaTeX-close-environment (&optional reopen) "Create an \\end{...} to match the current environment. -With prefix-argument, reopen environment afterwards." +With prefix-argument REOPEN, reopen environment afterwards." (interactive "*P") (if (> (point) (save-excursion @@ -5266,6 +5266,9 @@ See `fill-move-to-break-point' for the meaning of LINEBEG." (defun LaTeX-fill-paragraph (&optional justify) "Like `fill-paragraph', but handle LaTeX comments. + +With prefix argument JUSTIFY, justify as well. + If any of the current line is a comment, fill the comment or the paragraph of it that point is in. Code comments, that is, comments with uncommented code preceding them in the same line, will not @@ -5564,7 +5567,9 @@ environments." (TeX-activate-region))) (defun LaTeX-fill-environment (justify) - "Fill and indent current environment as LaTeX text." + "Fill and indent current environment as LaTeX text. + +With prefix argument JUSTIFY, justify as well." (interactive "*P") (save-excursion (LaTeX-mark-environment) @@ -5573,7 +5578,9 @@ environments." (concat " environment " (TeX-match-buffer 1))))) (defun LaTeX-fill-section (justify) - "Fill and indent current logical section as LaTeX text." + "Fill and indent current logical section as LaTeX text. + +With prefix argument JUSTIFY, justify as well." (interactive "*P") (save-excursion (LaTeX-mark-section) @@ -5608,7 +5615,9 @@ value of NO-SUBSECTIONS." (TeX-activate-region)) (defun LaTeX-fill-buffer (justify) - "Fill and indent current buffer as LaTeX text." + "Fill and indent current buffer as LaTeX text. + +With prefix argument JUSTIFY, justify as well." (interactive "*P") (save-excursion (LaTeX-fill-region -- 2.42.0 --=-=-=-- From unknown Thu Jun 19 14:06:50 2025 X-Loop: help-debbugs@gnu.org Subject: bug#71215: PATCH for docstrings Resent-From: Arash Esbati Original-Sender: "Debbugs-submit" Resent-CC: bug-auctex@gnu.org Resent-Date: Mon, 27 May 2024 05:20:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 71215 X-GNU-PR-Package: auctex X-GNU-PR-Keywords: To: 71215@debbugs.gnu.org Cc: Jeremy Bryant , 71215-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.171678719221088 (code B ref -1); Mon, 27 May 2024 05:20:02 +0000 Received: (at submit) by debbugs.gnu.org; 27 May 2024 05:19:52 +0000 Received: from localhost ([127.0.0.1]:42888 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sBSm0-0005U3-2I for submit@debbugs.gnu.org; Mon, 27 May 2024 01:19:52 -0400 Received: from lists.gnu.org ([209.51.188.17]:55576) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sBSly-0005Tw-U6 for submit@debbugs.gnu.org; Mon, 27 May 2024 01:19:51 -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 1sBSlp-0000SK-EH for bug-auctex@gnu.org; Mon, 27 May 2024 01:19:42 -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 1sBSlo-00015I-Ul; Mon, 27 May 2024 01:19:40 -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=iY85uR5wxmYJ0Mmb32CkTZs7XCPUlh5xDtXpIUKIltA=; b=qzYITFDk2MWCdT+5akJA suJBbFA0Hy1nockteO6p37kwLGHqV44Um6XUYr3Gu7MrhunFGfa5Cc9ywsxtEZfESYcKRSqO/B/p+ skKBLMC17YVw3GxNTj30393IpsrsRQLKhs3mMRzOxmHply1A3yls4e2IPk4gKBLmLQK0Cweak8zCY A3Gbve8mWaipabdUN8udnCFmicOnHWvXquFXcNODoJALf60rSEW6aLuLxua0YY0aqqgSdgkmho3PE UXNc2bDX2PCz6zhWcF5pL/u8HSSDinoSgT2oQnG4LnyhOxMJI26bPWaeTTeyehj2N7voMxv+QCCHw 1e+KVWi+GGlxkQ==; From: Arash Esbati In-Reply-To: <874jakmizt.fsf@jeremybryant.net> (Jeremy Bryant via bug-auctex via Bug reporting list for AUCTeX's message of "Sun, 26 May 2024 21:11:02 +0100") References: <874jakmizt.fsf@jeremybryant.net> Date: Mon, 27 May 2024 07:19:36 +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: > This is a patch to improve docstrings in interactive functions from > M-x checkdoc fixes. Thanks, installed, and closing. Best, Arash From unknown Thu Jun 19 14:06:50 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#71215: closed (Re: bug#71215: PATCH for docstrings) Message-ID: References: <874jakmizt.fsf@jeremybryant.net> X-Gnu-PR-Message: they-closed 71215 X-Gnu-PR-Package: auctex Reply-To: 71215@debbugs.gnu.org Date: Mon, 27 May 2024 05:23:02 +0000 Content-Type: multipart/mixed; boundary="----------=_1716787382-21596-1" This is a multi-part message in MIME format... ------------=_1716787382-21596-1 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Your bug report #71215: PATCH for docstrings 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 71215@debbugs.gnu.org. --=20 71215: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=3D71215 GNU Bug Tracking System Contact help-debbugs@gnu.org with problems ------------=_1716787382-21596-1 Content-Type: message/rfc822 Content-Disposition: inline Content-Transfer-Encoding: 7bit Received: (at 71215-done) by debbugs.gnu.org; 27 May 2024 05:22:08 +0000 Received: from localhost ([127.0.0.1]:42895 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sBSoB-0005aR-IE for submit@debbugs.gnu.org; Mon, 27 May 2024 01:22:07 -0400 Received: from eggs.gnu.org ([209.51.188.92]:48206) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sBSo9-0005Zz-P6 for 71215-done@debbugs.gnu.org; Mon, 27 May 2024 01:22:06 -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 1sBSlo-00015I-Ul; Mon, 27 May 2024 01:19:40 -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=iY85uR5wxmYJ0Mmb32CkTZs7XCPUlh5xDtXpIUKIltA=; b=qzYITFDk2MWCdT+5akJA suJBbFA0Hy1nockteO6p37kwLGHqV44Um6XUYr3Gu7MrhunFGfa5Cc9ywsxtEZfESYcKRSqO/B/p+ skKBLMC17YVw3GxNTj30393IpsrsRQLKhs3mMRzOxmHply1A3yls4e2IPk4gKBLmLQK0Cweak8zCY A3Gbve8mWaipabdUN8udnCFmicOnHWvXquFXcNODoJALf60rSEW6aLuLxua0YY0aqqgSdgkmho3PE UXNc2bDX2PCz6zhWcF5pL/u8HSSDinoSgT2oQnG4LnyhOxMJI26bPWaeTTeyehj2N7voMxv+QCCHw 1e+KVWi+GGlxkQ==; From: Arash Esbati To: Jeremy Bryant via bug-auctex via Bug reporting list for AUCTeX Subject: Re: bug#71215: PATCH for docstrings In-Reply-To: <874jakmizt.fsf@jeremybryant.net> (Jeremy Bryant via bug-auctex via Bug reporting list for AUCTeX's message of "Sun, 26 May 2024 21:11:02 +0100") References: <874jakmizt.fsf@jeremybryant.net> Date: Mon, 27 May 2024 07:19:36 +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: 71215-done Cc: Jeremy Bryant , 71215-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: > This is a patch to improve docstrings in interactive functions from > M-x checkdoc fixes. Thanks, installed, and closing. Best, Arash ------------=_1716787382-21596-1 Content-Type: message/rfc822 Content-Disposition: inline Content-Transfer-Encoding: 7bit Received: (at submit) by debbugs.gnu.org; 26 May 2024 20:11:36 +0000 Received: from localhost ([127.0.0.1]:42626 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sBKDQ-00036w-9l for submit@debbugs.gnu.org; Sun, 26 May 2024 16:11:36 -0400 Received: from lists.gnu.org ([209.51.188.17]:41574) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sBKDN-00036g-Cr for submit@debbugs.gnu.org; Sun, 26 May 2024 16:11:34 -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 1sBKDE-0004kM-GX for bug-auctex@gnu.org; Sun, 26 May 2024 16:11:24 -0400 Received: from out-174.mta1.migadu.com ([2001:41d0:203:375::ae]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1sBKDC-0005KP-In for bug-auctex@gnu.org; Sun, 26 May 2024 16:11:24 -0400 X-Envelope-To: bug-auctex@gnu.org DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=jeremybryant.net; s=key1; t=1716754274; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type; bh=rU3GPEUrJbRnnAjxqktLIeSvaJ5x23uH8B/eurkGX+o=; b=FE4/dp/B9+v9fI2omgXON0RWePVtFwDkZsWvLasTgVj3Zfxedc2TpSY8LxVXvFsxsKlGIm 51CXSSe5nibTQfu+oTERVYIBKbKIXh4u7lFgrVOgYV6Y7HYWQLrYRM6KaKQWp00Wno8gSb whhkMeeYZ3R5VG36jq96lScQBU5xyo+xfT9714PJOD2eAwi/ApEJiAP5C/jmusXLzYpso3 bUaIExi3ORQQ69JhkTA9H4NsovkmvOqlCksQZmoC/b89LYHgrYJwZUsaZypa/Zqoq7OV6/ qKTeRKP/Br+OzpdrwvVfHiks9mJeT3j+6ZxCKh6FEUTP8P2zKbpvquHnYvu/sQ== 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: PATCH for docstrings Date: Sun, 26 May 2024 21:11:02 +0100 Message-ID: <874jakmizt.fsf@jeremybryant.net> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Migadu-Flow: FLOW_OUT Received-SPF: pass client-ip=2001:41d0:203:375::ae; envelope-from=jb@jeremybryant.net; helo=out-174.mta1.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, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-Spam-Score: -1.4 (-) X-Debbugs-Envelope-To: submit 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 Hi, This is a patch to improve docstrings in interactive functions from M-x checkdoc fixes. --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0001-Improve-documentation-for-interactive-functions-Chec.patch >From 02919173dd5351eefd20119c457a24255a5b2ec7 Mon Sep 17 00:00:00 2001 From: Jeremy Bryant Date: Sun, 26 May 2024 21:04:51 +0100 Subject: [PATCH] Improve documentation for interactive functions (Checkdoc fixes) * latex.el (LaTeX-environment): Correct docstring for required arg. (LaTeX-close-environment, LaTeX-fill-paragraph) (LaTeX-fill-environment, LaTeX-fill-section) (LaTeX-fill-buffer): Capitalize argument. --- latex.el | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/latex.el b/latex.el index baedfdc8..e0c90712 100644 --- a/latex.el +++ b/latex.el @@ -583,7 +583,7 @@ Styles such as tabularx may set it according to their needs.") (defun LaTeX-environment (arg) "Make LaTeX environment (\\begin{...}-\\end{...} pair). -With optional ARG, modify current environment. +With prefix ARG, modify current environment. It may be customized with the following variables: @@ -652,7 +652,7 @@ It may be customized with the following variables: (defun LaTeX-close-environment (&optional reopen) "Create an \\end{...} to match the current environment. -With prefix-argument, reopen environment afterwards." +With prefix-argument REOPEN, reopen environment afterwards." (interactive "*P") (if (> (point) (save-excursion @@ -5266,6 +5266,9 @@ See `fill-move-to-break-point' for the meaning of LINEBEG." (defun LaTeX-fill-paragraph (&optional justify) "Like `fill-paragraph', but handle LaTeX comments. + +With prefix argument JUSTIFY, justify as well. + If any of the current line is a comment, fill the comment or the paragraph of it that point is in. Code comments, that is, comments with uncommented code preceding them in the same line, will not @@ -5564,7 +5567,9 @@ environments." (TeX-activate-region))) (defun LaTeX-fill-environment (justify) - "Fill and indent current environment as LaTeX text." + "Fill and indent current environment as LaTeX text. + +With prefix argument JUSTIFY, justify as well." (interactive "*P") (save-excursion (LaTeX-mark-environment) @@ -5573,7 +5578,9 @@ environments." (concat " environment " (TeX-match-buffer 1))))) (defun LaTeX-fill-section (justify) - "Fill and indent current logical section as LaTeX text." + "Fill and indent current logical section as LaTeX text. + +With prefix argument JUSTIFY, justify as well." (interactive "*P") (save-excursion (LaTeX-mark-section) @@ -5608,7 +5615,9 @@ value of NO-SUBSECTIONS." (TeX-activate-region)) (defun LaTeX-fill-buffer (justify) - "Fill and indent current buffer as LaTeX text." + "Fill and indent current buffer as LaTeX text. + +With prefix argument JUSTIFY, justify as well." (interactive "*P") (save-excursion (LaTeX-fill-region -- 2.42.0 --=-=-=-- ------------=_1716787382-21596-1--