From: Ihor Radchenko <yantar92@gmail.com>
To: Stefan Monnier <monnier@iro.umontreal.ca>
Cc: Lars Ingebrigtsen <larsi@gnus.org>,
"Basil L. Contovounesios" <contovob@tcd.ie>,
emacs-devel@gnu.org
Subject: Re: master 48aacbf292 2/2: Make many seldom-used generalized variables obsolete
Date: Sun, 11 Sep 2022 17:33:53 +0800 [thread overview]
Message-ID: <87sfkyw8zi.fsf@localhost> (raw)
In-Reply-To: <jwv5yhvgvh6.fsf-monnier+emacs@gnu.org>
Stefan Monnier <monnier@iro.umontreal.ca> writes:
>>> Would it be possible to accept docstring in gv-define-setter and then
>>> display it in the help buffer for the relevant variable?
>> It would be possible, but then we'd just be encouraging people to write
>> illegible code.
>
> Largely agreed. There is some occasional need for documentation of the
> setter, for example we could argue that `alist-get` (when used as a gv)
> should document that the ALIST argument needs to be a gv-place as
> well. But when needed it can be added to the function's docstring.
> So, I'm leaning towards YAGNI.
I do not have anything against this paradigm.
However, it would be useful then to document this convention in
"12.17.2 Defining new ‘setf’ forms" section of the Elisp manual.
--
Ihor Radchenko,
Org mode contributor,
Learn more about Org mode at https://orgmode.org/.
Support Org development at https://liberapay.com/org-mode,
or support my work at https://liberapay.com/yantar92
next prev parent reply other threads:[~2022-09-11 9:33 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <166111278304.2846.13033924580993120733@vcs2.savannah.gnu.org>
[not found] ` <20220821201303.AD1E6C0088A@vcs2.savannah.gnu.org>
2022-08-25 10:39 ` master 48aacbf292 2/2: Make many seldom-used generalized variables obsolete Basil L. Contovounesios
2022-08-25 12:41 ` Lars Ingebrigtsen
2022-09-10 5:17 ` Ihor Radchenko
2022-09-10 6:45 ` Lars Ingebrigtsen
2022-09-10 7:02 ` Ihor Radchenko
2022-09-10 7:07 ` Lars Ingebrigtsen
2022-09-10 14:25 ` Stefan Monnier
2022-09-11 9:33 ` Ihor Radchenko [this message]
2022-09-10 14:21 ` Stefan Monnier
2022-09-11 17:11 ` Sean Whitton
2022-09-11 17:57 ` Lars Ingebrigtsen
2022-09-18 23:10 ` Jonas Bernoulli
2022-09-19 6:00 ` Lars Ingebrigtsen
2022-09-19 10:01 ` Jonas Bernoulli
2022-09-19 11:38 ` Augusto Stoffel
2022-09-19 12:22 ` Lars Ingebrigtsen
2022-09-19 12:35 ` Augusto Stoffel
2022-09-19 12:37 ` Lars Ingebrigtsen
2022-09-19 12:51 ` Augusto Stoffel
2022-09-19 12:21 ` Lars Ingebrigtsen
2022-09-19 12:46 ` Stefan Monnier
2022-09-19 12:54 ` Po Lu
2022-09-19 13:05 ` Lars Ingebrigtsen
2022-09-19 12:46 ` Stefan Monnier
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=87sfkyw8zi.fsf@localhost \
--to=yantar92@gmail.com \
--cc=contovob@tcd.ie \
--cc=emacs-devel@gnu.org \
--cc=larsi@gnus.org \
--cc=monnier@iro.umontreal.ca \
/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).