From: Eli Zaretskii <eliz@gnu.org>
To: Gabriel <gabriel376@hotmail.com>, Lars Ingebrigtsen <larsi@gnus.org>
Cc: 49373@debbugs.gnu.org
Subject: bug#49373: 28.0.50; [PATCH] Use 'remember-buffer' in remember.el doc strings
Date: Sun, 04 Jul 2021 19:37:34 +0300 [thread overview]
Message-ID: <83pmvyghm9.fsf@gnu.org> (raw)
In-Reply-To: <CH2PR01MB5879EC34DD9AC3829A92E3FB8B1D9@CH2PR01MB5879.prod.exchangelabs.com> (message from Gabriel on Sun, 04 Jul 2021 12:21:42 -0300)
> From: Gabriel <gabriel376@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?
next prev parent reply other threads:[~2021-07-04 16:37 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-07-04 5:15 bug#49373: 28.0.50; [PATCH] Use 'remember-buffer' in remember.el doc strings Gabriel
2021-07-04 6:02 ` Eli Zaretskii
2021-07-04 15:21 ` Gabriel
2021-07-04 16:37 ` Eli Zaretskii [this message]
2021-07-05 13:20 ` Lars Ingebrigtsen
2021-07-19 15:48 ` Lars Ingebrigtsen
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=83pmvyghm9.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=49373@debbugs.gnu.org \
--cc=gabriel376@hotmail.com \
--cc=larsi@gnus.org \
/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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.