unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Eshel Yaron <me@eshelyaron.com>
To: emacs-devel@gnu.org
Cc: Stefan Kangas <stefankangas@gmail.com>
Subject: Re: emacs-30 73c1252bb6b: Fix link to major mode variable in docstring
Date: Mon, 08 Jul 2024 11:34:18 +0200	[thread overview]
Message-ID: <m1zfqsb52d.fsf@dazzs-mbp.home> (raw)
In-Reply-To: <20240628101855.7E69DC2BC60@vcs2.savannah.gnu.org> (Stefan Kangas's message of "Fri, 28 Jun 2024 06:18:55 -0400 (EDT)")

Hi Stefan,

Stefan Kangas <stefankangas@gmail.com> writes:

> branch: emacs-30
> commit 73c1252bb6b7cc61d9f992818568d3c57de4ff67
> Author: Stefan Kangas <stefankangas@gmail.com>
> Commit: Stefan Kangas <stefankangas@gmail.com>
>
>     Fix link to major mode variable in docstring
>     
>     * lisp/emacs-lisp/easy-mmode.el (easy-mmode--arg-docstring): Fix link to
>     major mode variable in docstring.  (Bug#71815)
> ---
>  lisp/emacs-lisp/easy-mmode.el | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/lisp/emacs-lisp/easy-mmode.el b/lisp/emacs-lisp/easy-mmode.el
> index ba0f8bad393..12712cb2bc3 100644
> --- a/lisp/emacs-lisp/easy-mmode.el
> +++ b/lisp/emacs-lisp/easy-mmode.el
> @@ -91,7 +91,7 @@ Enable the mode if ARG is nil, omitted, or is a positive number.
>  Disable the mode if ARG is a negative number.
>  
>  To check whether the minor mode is enabled in the current buffer,
> -evaluate `%s'.
> +evaluate the variable `%s'.
>  
>  The mode's hook is called both when the mode is enabled and when
>  it is disabled.")

I think it's not always correct to say "the variable" here, because that
"%s" may be replaced with a form that's not just a variable.  E.g. now
C-h f global-auto-revert-mode RET says:

  To check whether the minor mode is enabled in the current buffer,
  evaluate the variable ‘(default-value 'global-auto-revert-mode)’.


Best,

Eshel



       reply	other threads:[~2024-07-08  9:34 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <171956993509.30805.5525504753117432129@vcs2.savannah.gnu.org>
     [not found] ` <20240628101855.7E69DC2BC60@vcs2.savannah.gnu.org>
2024-07-08  9:34   ` Eshel Yaron [this message]
2024-07-08 11:48     ` emacs-30 73c1252bb6b: Fix link to major mode variable in docstring Stefan Kangas
2024-07-08 15:58       ` Thierry Volpiatto
2024-07-08 23:26         ` Michael Heerdegen via Emacs development discussions.
2024-07-09  0:37           ` Michael Heerdegen via Emacs development discussions.
2024-07-09  4:22         ` Thierry Volpiatto
2024-07-09  5:01           ` Michael Heerdegen via Emacs development discussions.
     [not found]             ` <87y16b3zhk.fsf@posteo.net>
     [not found]               ` <87r0c3f1a4.fsf@web.de>
2024-07-09 10:06                 ` Thierry Volpiatto

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=m1zfqsb52d.fsf@dazzs-mbp.home \
    --to=me@eshelyaron.com \
    --cc=emacs-devel@gnu.org \
    --cc=stefankangas@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).