GNU bug report logs - #49373
28.0.50; [PATCH] Use 'remember-buffer' in remember.el doc strings

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 49373 in the body.
You can then email your comments to 49373 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Gabriel <gabriel376 <at> hotmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 28.0.50; [PATCH] Use 'remember-buffer' in remember.el doc strings
Date: Sun, 04 Jul 2021 02:15:14 -0300

[Message part 1 (text/plain, inline)]

This patch replaces the hard coded '*Remember*' string with
'remember-buffer' in all doc strings occurrences in remember.el.

[0001-Use-remember-buffer-in-remember.el-doc-strings.patch (text/x-patch, attachment)]

Message #8 received at 49373 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Gabriel <gabriel376 <at> hotmail.com>
Cc: 49373 <at> debbugs.gnu.org
Subject: Re: bug#49373: 28.0.50;
 [PATCH] Use 'remember-buffer' in remember.el doc strings
Date: Sun, 04 Jul 2021 09:02:38 +0300

> From: Gabriel <gabriel376 <at> hotmail.com>
> Date: Sun, 04 Jul 2021 02:15:14 -0300
> 
> This patch replaces the hard coded '*Remember*' string with
> 'remember-buffer' in all doc strings occurrences in remember.el.

remember-buffer is an internal variable, so exposing it in the doc
strings of public functions, let alone commands, is not necessarily
TRT?

Message #11 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Gabriel <gabriel376 <at> hotmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: Re: bug#49373: 28.0.50; [PATCH] Use 'remember-buffer' in
 remember.el doc strings
Date: Sun, 04 Jul 2021 12:21:42 -0300

Eli Zaretskii <eliz <at> gnu.org> writes:

>> From: Gabriel <gabriel376 <at> hotmail.com>
>> Date: Sun, 04 Jul 2021 02:15:14 -0300
>> 
>> This patch replaces the hard coded '*Remember*' string with
>> 'remember-buffer' in all doc strings occurrences in remember.el.
>
> remember-buffer is an internal variable, so exposing it in the doc
> strings of public functions, let alone commands, is not necessarily
> TRT?

Hi Eli,

Good catch! I didn't notice that 'remember-buffer' is a defvar. Indeed
it does not make sense to refer to an internal variable in the doc
string of public functions.

Perhaps the 'remember-buffer' could be changed to a defcustom?

By the way, the 'remember-initial-contents' seems to be another
candidate for a defcustom, but I am not sure if I really understood its
use case. It's an internal variable, with a default value of nil, that
is not set anywhere and reset to nil on every call of 'remember'. If we
set a value and remove the reset inside 'remember', it works as
described by the name and by the doc string: "Initial contents to place
into *Remember* buffer.".

If the maintainers decide to not change any defvar to defcustom, feel
free to close this bug report.

Thank you,
Gabriel

Message #14 received at 49373 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Gabriel <gabriel376 <at> hotmail.com>,
    Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 49373 <at> debbugs.gnu.org
Subject: Re: bug#49373: 28.0.50;
 [PATCH] Use 'remember-buffer' in remember.el doc strings
Date: Sun, 04 Jul 2021 19:37:34 +0300

> From: Gabriel <gabriel376 <at> hotmail.com>
> Date: Sun, 04 Jul 2021 12:21:42 -0300
> 
> > remember-buffer is an internal variable, so exposing it in the doc
> > strings of public functions, let alone commands, is not necessarily
> > TRT?
> 
> Hi Eli,
> 
> Good catch! I didn't notice that 'remember-buffer' is a defvar. Indeed
> it does not make sense to refer to an internal variable in the doc
> string of public functions.
> 
> Perhaps the 'remember-buffer' could be changed to a defcustom?

I won't object, if that would help in some use cases.

Lars, WDYT?

> By the way, the 'remember-initial-contents' seems to be another
> candidate for a defcustom, but I am not sure if I really understood its
> use case. It's an internal variable, with a default value of nil, that
> is not set anywhere and reset to nil on every call of 'remember'. If we
> set a value and remove the reset inside 'remember', it works as
> described by the name and by the doc string: "Initial contents to place
> into *Remember* buffer.".

Same response here: would that be useful enough?

Message #17 received at 49373 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: Gabriel <gabriel376 <at> hotmail.com>, 49373 <at> debbugs.gnu.org
Subject: Re: bug#49373: 28.0.50; [PATCH] Use 'remember-buffer' in
 remember.el doc strings
Date: Mon, 05 Jul 2021 15:20:51 +0200

Eli Zaretskii <eliz <at> gnu.org> writes:

>> Perhaps the 'remember-buffer' could be changed to a defcustom?
>
> I won't object, if that would help in some use cases.
>
> Lars, WDYT?

Sure; fine by me.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Message #20 received at 49373 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Gabriel <gabriel376 <at> hotmail.com>
Cc: 49373 <at> debbugs.gnu.org
Subject: Re: bug#49373: 28.0.50; [PATCH] Use 'remember-buffer' in
 remember.el doc strings
Date: Mon, 19 Jul 2021 17:48:03 +0200

Gabriel <gabriel376 <at> hotmail.com> writes:

> This patch replaces the hard coded '*Remember*' string with
> 'remember-buffer' in all doc strings occurrences in remember.el.

Thanks; applied to Emacs 28 (and I also made remember-buffer into a
defcustom).

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.