Subject: Re: bug#72405: 29.4; Doc string of `org-indent-mode'

From: Eli Zaretskii <[email-masked]>
Date: Wed, 14 Aug 2024 09:12:38 +0300

> From: Visuwesh <[email-masked]>
> Cc: Eli Zaretskii <[email-masked]>,  [email-masked],
>   [email-masked]
> Date: Wed, 14 Aug 2024 08:09:20 +0530
> 
> Thanks, so I've attached a properly formatted patch.
> 
> 
> >From 535ae70653745f529742993f7fc26daf00666713 Mon Sep 17 00:00:00 2001
> From: Visuwesh <[email-masked]>
> 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'.
            ^^^^^
This looks like a bug (I know it isn't, but it looks like one).  Can
we instead use just %s here, and generate the full string, including
the "the variable" part, in the code that uses the format?

Thanks.