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: Thu, 01 Aug 2024 11:29:12 +0530 Message-ID: <8734noiy1b.fsf@gmail.com> References: <86cymsyguu.fsf@gnu.org> <877cd0iyw4.fsf@gmail.com> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="5828"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Cc: 72405@debbugs.gnu.org, Drew Adams To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Thu Aug 01 08:01:00 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 1sZOry-0001JP-S7 for geb-bug-gnu-emacs@m.gmane-mx.org; Thu, 01 Aug 2024 08:00:59 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sZOrq-0006oC-90; Thu, 01 Aug 2024 02:00:50 -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 1sZOrn-0006nw-1h for bug-gnu-emacs@gnu.org; Thu, 01 Aug 2024 02:00:47 -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 1sZOrl-0008Tu-Hk for bug-gnu-emacs@gnu.org; Thu, 01 Aug 2024 02:00:45 -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=vNtPggYc7CAUQ93KQ/k0sr9uiE6LKPl+iGjL6heo7Ic=; b=NVFChSQBIj6qcImzSPwksCq+x0FQSBZK4Me9tAY5soJ8Wh5qISykZFhOVQ2UKuQmHSWZAFcL+2iMAyMyDN8sn86biEN4i6J2ES/nZKcMx+nuWuXu9EPIeFKcNhfjWqYOvAAqfpIvOOJ1ZyZ8PSt6LOGrFWEYgttf45tevkMQENkTQB60ccZnJ0KtvO2EokmzlaDGkchOrpLFsUi3UK8UxTWjVPnLV3UvDBCiy7LXgr6i72NOP0bSa6idb4nWWOc77PSXV4smzhB5XhaFIjYjTViU0scRRe780fKWxDdcSMZDVqkBVlZEozGUHkd/hCOY+koFY1SDgatZIRO4K82zdw==; Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1sZOs1-0000ki-Ne for bug-gnu-emacs@gnu.org; Thu, 01 Aug 2024 02:01:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Visuwesh Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 01 Aug 2024 06:01: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.17224920412854 (code B ref 72405); Thu, 01 Aug 2024 06:01:01 +0000 Original-Received: (at 72405) by debbugs.gnu.org; 1 Aug 2024 06:00:41 +0000 Original-Received: from localhost ([127.0.0.1]:50694 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sZOrg-0000jw-FI for submit@debbugs.gnu.org; Thu, 01 Aug 2024 02:00:40 -0400 Original-Received: from mail-pl1-f195.google.com ([209.85.214.195]:47104) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sZOrd-0000jj-UU for 72405@debbugs.gnu.org; Thu, 01 Aug 2024 02:00:38 -0400 Original-Received: by mail-pl1-f195.google.com with SMTP id d9443c01a7336-1fd66cddd07so47925435ad.2 for <72405@debbugs.gnu.org>; Wed, 31 Jul 2024 23:00:21 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1722491955; x=1723096755; darn=debbugs.gnu.org; h=content-transfer-encoding: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=vNtPggYc7CAUQ93KQ/k0sr9uiE6LKPl+iGjL6heo7Ic=; b=KpaUPQZ3r0bq/Gc5c9mx/QDQygfsmgmcXyP+PeV9RX/EZF7kiWYaUDy18Fo9kh7hfv uGXfKcQZ8Xnz8K6hA6eRDFp84HntgMk0MEoeKjcf4cn8Rd1P+9i/lqTuqBHEszM54Gu9 QCRyx2BRRNMSxZV5IbzcBxhZuL+nzrrro7WEOrUHJ5aG7TzxymVxCN29GTihQGNznJgx I8M5W58rmmE9xARL7VyoECva+gU8tmrJWy8gDoCKihLrY0aZJRB1hJgKQ/MIwiNUUY8+ t9cBQ4B6bBtjntP0araGtGjhNwUsOn3zm2yvU3FpLJCxI1qC9hraTAHFdOJntHdEw6hO H0Rw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1722491955; x=1723096755; h=content-transfer-encoding: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=vNtPggYc7CAUQ93KQ/k0sr9uiE6LKPl+iGjL6heo7Ic=; b=TnfGjXbL+WWrj6588MHlQUs2dLjFYXiEBss1q/rRMWtOWlToCFL9c3AN2mvDM56cs3 UDv9UqWeT2rwr/DmT9xwdeWFo6nPw9LkxR402/H4mTIHiJ4IuD91LCQNdeqk5ySM21Tw Pm/X3zCBVmP+pJwSlB84gkBKEBq7eiWB0BNMBvzo8Ds9exblbiXV+TISqs64B3Df6Yx9 czI6UVyrB/q+0fR3ghEp2wVCTqH0EJbl5Ntvad3GEnn3NJCoV1ecGGwYs+WMbcjJ9/e3 Vy3f6J7Ee+inBUfwASRrypImNCMs//3AN+3GFjPVgz++L8PUtxBU5zAscYadM/pBrt75 b87Q== X-Gm-Message-State: AOJu0Yy5eoViHrw1vHfhos7EcFvRTj+xG8bUY+jRHbQ5iTcL7dHwlLwe /FRtGMZCtxXn/6IrSk+nlMNho+wbgH4zSrmcae0jom062LxhV1fHTvfaDY5J X-Google-Smtp-Source: AGHT+IE/D3+9+/PA6lgXOengfMK5HuKwpWdQHww1ljJePk0NuHUTMwgBTzg19jrR6WgY3fZyw6gyfw== X-Received: by 2002:a17:903:120e:b0:1fc:55ab:8760 with SMTP id d9443c01a7336-1ff4cea7175mr15212695ad.27.1722491955420; Wed, 31 Jul 2024 22:59:15 -0700 (PDT) Original-Received: from localhost ([49.204.137.179]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-1fed7f1b7dfsm129653235ad.189.2024.07.31.22.59.14 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 31 Jul 2024 22:59:15 -0700 (PDT) In-Reply-To: <877cd0iyw4.fsf@gmail.com> (Visuwesh's message of "Thu, 01 Aug 2024 11:10:43 +0530") 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:289602 Archived-At: [=E0=AE=B5=E0=AE=BF=E0=AE=AF=E0=AE=BE=E0=AE=B4=E0=AE=A9=E0=AF=8D =E0=AE=86= =E0=AE=95=E0=AE=B8=E0=AF=8D=E0=AE=9F=E0=AF=8D 01, 2024] Visuwesh wrote: > [=E0=AE=B5=E0=AE=BF=E0=AE=AF=E0=AE=BE=E0=AE=B4=E0=AE=A9=E0=AF=8D =E0=AE= =86=E0=AE=95=E0=AE=B8=E0=AF=8D=E0=AE=9F=E0=AF=8D 01, 2024] Eli Zaretskii wr= ote: > >>> Date: Wed, 31 Jul 2024 20:23:59 +0000 >>> From: Drew Adams via "Bug reports for GNU Emacs, >>> the Swiss army knife of text editors" >>>=20 >>> Likely applies also to other minor-mode doc strings. >>>=20 >>> emacs -Q >>> C-h f org-indent-mode >>> ____ >>>=20 >>> That shows you doc that includes this, where `org-indent-mode' is a link >>> intended to give you information about the _variable_ of that name: >>>=20 >>> To check whether the minor mode is enabled in the current buffer, >>> evaluate 'org-indent-mode'. >>>=20 >>> Clicking that link doesn't take you to the _variable_ part of the *Help* >>> buffer; it just puts you back at the start of the buffer (after >>> redrawing it uselessly). >>>=20 >>> It should take you to the description of the variable. And the sentence >>> should include the word "variable" before `org-indent-mode'; otherwise, >>> it makes little sense to speak of evaluating that symbol, and the text >>> can confuse or mislead users. >> >> Thanks, but please report Org issues to the Org mailing list first. >> If the Org developers determine it's a core Emacs problem (which is >> hardly possible in this case, but who knows?), then it should be >> reported here. > > That sentence is part of easy-mmode--arg-docstring that gets added to > all the minor-mode docstrings. So it is not org-mode specific. For > example, font-lock-mode also has the following text: > > To check whether the minor mode is enabled in the current buffer, > evaluate =E2=80=98font-lock-mode=E2=80=99. 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. diff --git a/lisp/emacs-lisp/easy-mmode.el b/lisp/emacs-lisp/easy-mmode.el index ba0f8bad393..2262fb8ed5b 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. =20 To check whether the minor mode is enabled in the current buffer, -evaluate `%s'. +evaluate %s`%s'. =20 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 "'" "\\=3D'" (format "%S" getter))= ))) (let ((start (point)))