From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Visuwesh Newsgroups: gmane.emacs.bugs Subject: bug#72405: 29.4; Doc string of `org-indent-mode' Date: Wed, 14 Aug 2024 08:09:20 +0530 Message-ID: <87frr7zv3b.fsf@gmail.com> References: <86cymsyguu.fsf@gnu.org> <877cd0iyw4.fsf@gmail.com> <8734noiy1b.fsf@gmail.com> <86zfpwwyu4.fsf@gnu.org> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="2745"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Cc: Eli Zaretskii , 72405@debbugs.gnu.org, drew.adams@oracle.com To: Stefan Monnier Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Wed Aug 14 04:41:53 2024 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1se3xR-0000a7-1t for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 14 Aug 2024 04:41:53 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1se3x5-00023k-R3; Tue, 13 Aug 2024 22:41:31 -0400 Original-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 1se3x1-00023b-UY for bug-gnu-emacs@gnu.org; Tue, 13 Aug 2024 22:41:27 -0400 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1se3x1-0002mo-L8 for bug-gnu-emacs@gnu.org; Tue, 13 Aug 2024 22:41:27 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=debbugs.gnu.org; s=debbugs-gnu-org; h=MIME-Version:Date:References:In-Reply-To:From:To:Subject; bh=Vfr8x0MB6B2Rg/GaFFiSEMZrSEdtW15Jj4vz2fXfshA=; b=K76bMM/MmpwOAI45HGy4oWyOZYwiYQMS3Zmbgf8B4kl6QRkGmW09KFO0g33Y4IDC+9tvLb++sCTdxZqhq6LiVGMsR9ig8cXZ9oSnsPwkD4rvUPfXJYnEIgMDmXnFacFohHtCOaVIZEu8gkz0fardd5n8N55uX0fTn8nbPfKeLCtjuh3YoDOSeajm67RiWFarYI/zygsSEiCpMewc/BJCumF5eHA0zjfO9ZcQLFPI+ENCGcDHdmZiQpELpqnR6Cz00cMJAT03VkXJ8Xeg2eZCmGBzc1pl3iAg4wHrRIAoy9V5NPnXSM6iHOcfjdtuR8toEBrU1PsF9CEQTJatyUn8pQ==; Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1se3xZ-0003u1-JE for bug-gnu-emacs@gnu.org; Tue, 13 Aug 2024 22:42:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Visuwesh Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 14 Aug 2024 02:42:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 72405 X-GNU-PR-Package: emacs Original-Received: via spool by 72405-submit@debbugs.gnu.org id=B72405.172360327214940 (code B ref 72405); Wed, 14 Aug 2024 02:42:01 +0000 Original-Received: (at 72405) by debbugs.gnu.org; 14 Aug 2024 02:41:12 +0000 Original-Received: from localhost ([127.0.0.1]:45788 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1se3wl-0003su-F6 for submit@debbugs.gnu.org; Tue, 13 Aug 2024 22:41:11 -0400 Original-Received: from mail-pl1-f193.google.com ([209.85.214.193]:44202) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1se3wj-0003sf-2j for 72405@debbugs.gnu.org; Tue, 13 Aug 2024 22:41:09 -0400 Original-Received: by mail-pl1-f193.google.com with SMTP id d9443c01a7336-1fc47abc040so41108535ad.0 for <72405@debbugs.gnu.org>; Tue, 13 Aug 2024 19:40:34 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1723603168; x=1724207968; darn=debbugs.gnu.org; h=mime-version:user-agent:message-id:date:references:in-reply-to :subject:cc:to:from:from:to:cc:subject:date:message-id:reply-to; bh=Vfr8x0MB6B2Rg/GaFFiSEMZrSEdtW15Jj4vz2fXfshA=; b=F3wyTdneIZipZUpeASWh5fBe966L0Jwwa4sIZWqr98fLf3JLlM1nNqqZeOFUBgJ7lB ECaExbXaLV47JxKwAFDt7wBy7E+abWYbRxQsuG1cIc+YIxMCfpS5uTA87M5p9K1hbHsY KVkAoaQQTNS0VAIiOqRxiN9JTHtiqE8n5sIvY6k+NU3t1jNkP/x4acONM8kvv+K9bXMk myX2iCvDSROCgUhTl+MzUv7rmiD8xLpT68Ej0pZ90ARrzo6EE6uOncvojnaV1j5T98ry HTy5ayWJstZTNdLCspVlcrzSsh4m+DaLvIy3S/kwy23OAtxCXHkeJqxNLmS553n7FAym yDnw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1723603168; x=1724207968; h=mime-version:user-agent:message-id:date:references:in-reply-to :subject:cc:to:from:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=Vfr8x0MB6B2Rg/GaFFiSEMZrSEdtW15Jj4vz2fXfshA=; b=ss/Ena7KwwYTUy1Nnh6L8G7z1GEqSlhgX7pWmZSt2+uZRJ0BniHMmptyms7KufAfXe 3qkeW3vikvNiP2xALEv6KuMGx9oQ9coVMx/tquoQjDUF38BnsAn6adQwzIb8Z/jjnEB1 K5hPgod/Jfl6D2qKAuQJ0AAprAGN9nWSh8o61HT59tKReOm1rQYGUhxM6wecrgOexrHT 8EK9Uk+qJKqNWrHQSXZc4E0XtNQK0EvtLUOebjsAAp4jJZF9oF+vp/gpaPION1SS84us K9s6CnJSdCs2LPuf4mhNH9Y8fDwUAA11plhnzivMSMro9nfWsSHZcaff9XA2SlMjd8sI ULJQ== X-Forwarded-Encrypted: i=1; AJvYcCVRzV4dR/byOANLRuDcai6dR6sBJ6TocQwLfL1p72W7EUJEPKPPEA+6CKqCXn8sHJbQdMAZXSz6e6vjIXRTo6SPTnJcJ5k= X-Gm-Message-State: AOJu0YwrAhovNgjtkzoK1FJR+mBCCpgk3DH5c1RmMnut2j/7HoY7QBME YTcWE93TQgaYVboAxb60QIWEbjcYFBLqf4zqqTmqFYxPmWBmPdWA X-Google-Smtp-Source: AGHT+IHxAJuVueS+1hg4FP55YOUD1XfGSgQkIKq46A3JTGOevzONXz2OT9YAJDMNEq6MXAEksbEdSA== X-Received: by 2002:a17:902:e888:b0:1fb:59e6:b0e5 with SMTP id d9443c01a7336-201d63dc35amr17975215ad.19.1723603168294; Tue, 13 Aug 2024 19:39:28 -0700 (PDT) Original-Received: from localhost ([115.240.90.130]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-201cd1bd2c4sm19945165ad.235.2024.08.13.19.39.25 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 13 Aug 2024 19:39:26 -0700 (PDT) In-Reply-To: (Stefan Monnier via's message of "Tue, 13 Aug 2024 20:40:03 -0400") X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:290108 Archived-At: --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable [=E0=AE=9A=E0=AF=86=E0=AE=B5=E0=AF=8D=E0=AE=B5=E0=AE=BE=E0=AE=AF=E0=AF=8D = =E0=AE=86=E0=AE=95=E0=AE=B8=E0=AF=8D=E0=AE=9F=E0=AF=8D 13, 2024] Stefan Mon= nier via "Bug reports for GNU Emacs, the Swiss army knife of text editors" = wrote: >>> Here's a patch to make it insert "the variable " after evaluate. But >>> I'm not sure if (symbolp getter) will catch all non-variable cases. >>> AFAIU, GETTER can be any generalised variable. > [...] >> Stefan, any comments to this suggestion? > > Looks OK to me. > > > Stefan Thanks, so I've attached a properly formatted patch. --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0001-Disambiguate-minor-mode-variable-in-its-function-doc.patch >From 535ae70653745f529742993f7fc26daf00666713 Mon Sep 17 00:00:00 2001 From: Visuwesh Date: Wed, 14 Aug 2024 08:07:15 +0530 Subject: [PATCH] Disambiguate minor-mode variable in its function docstring * lisp/emacs-lisp/easy-mmode.el (easy-mmode--arg-docstring) (easy-mmode--mode-docstring): Add "the variable" before the GETTER if it is a symbol to properly link to minor-mode variable in the *Help* buffer in the common case. (bug#72405) --- lisp/emacs-lisp/easy-mmode.el | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lisp/emacs-lisp/easy-mmode.el b/lisp/emacs-lisp/easy-mmode.el index 944a74a91ee..5332a3b4fcf 100644 --- a/lisp/emacs-lisp/easy-mmode.el +++ b/lisp/emacs-lisp/easy-mmode.el @@ -91,7 +91,7 @@ easy-mmode--arg-docstring Disable the mode if ARG is a negative number. To check whether the minor mode is enabled in the current buffer, -evaluate `%s'. +evaluate %s`%s'. The mode's hook is called both when the mode is enabled and when it is disabled.") @@ -128,6 +128,7 @@ easy-mmode--mode-docstring easy-mmode--arg-docstring (if global "global " "") mode-pretty-name + (if (symbolp getter) "the variable " "") ;; Avoid having quotes turn into pretty quotes. (string-replace "'" "\\='" (format "%S" getter))))) (let ((start (point))) -- 2.45.2 --=-=-=--