From unknown Fri Jun 20 05:27:46 2025 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-Mailer: MIME-tools 5.509 (Entity 5.509) Content-Type: text/plain; charset=utf-8 From: bug#71215 <71215@debbugs.gnu.org> To: bug#71215 <71215@debbugs.gnu.org> Subject: Status: PATCH for docstrings Reply-To: bug#71215 <71215@debbugs.gnu.org> Date: Fri, 20 Jun 2025 12:27:46 +0000 retitle 71215 PATCH for docstrings reassign 71215 auctex submitter 71215 Jeremy Bryant severity 71215 normal thanks From debbugs-submit-bounces@debbugs.gnu.org Sun May 26 16:11:36 2024 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 --=-=-=-- From debbugs-submit-bounces@debbugs.gnu.org Mon May 27 01:19:52 2024 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 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: submit 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 From unknown Fri Jun 20 05:27:46 2025 Received: (at fakecontrol) by fakecontrolmessage; To: internal_control@debbugs.gnu.org From: Debbugs Internal Request Subject: Internal Control Message-Id: bug archived. Date: Mon, 24 Jun 2024 11:24:08 +0000 User-Agent: Fakemail v42.6.9 # This is a fake control message. # # The action: # bug archived. thanks # This fakemail brought to you by your local debbugs # administrator