unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Lars Ingebrigtsen <larsi@gnus.org>
To: Michael Heerdegen <michael_heerdegen@web.de>
Cc: Phil Sainty <psainty@orcon.net.nz>,
	52290@debbugs.gnu.org, Stefan Monnier <monnier@iro.umontreal.ca>
Subject: bug#52290: 28.0.90; Undocumented generalized variables
Date: Wed, 31 Aug 2022 11:58:41 +0200	[thread overview]
Message-ID: <87o7w091ke.fsf@gnus.org> (raw)
In-Reply-To: <87o7w1macy.fsf@web.de> (Michael Heerdegen's message of "Wed, 31 Aug 2022 04:10:21 +0200")

Michael Heerdegen <michael_heerdegen@web.de> writes:

> Ok - not that easy!  Alternatives I see are "... `setf'able'" or
> "... can be used in generalized variables" or "...in place expressions"
> or "can be used in gv forms - see [Generalized Variables]."

"`setf'-able" is perhaps an improvement -- I think more people know what
that means than "generalized variable".

> BTW, another problem is that `alist-get' tells how it works as place
> (because it's not totally trivial in this case), and at the end "... is
> also a generalized variable" is added - kind of misplaced because the
> reader already knows at this point.  Personally I would prefer that hint
> near the beginning (without "also") - in all cases I think.

The user has asked for the documentation for the function, so "also" is
appropriate.  And the info (that's it's setf-able) is unlikely to be
what most people are interested in, so keeping it at the bottom is fine.





  reply	other threads:[~2022-08-31  9:58 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-12-05  1:25 bug#52290: 28.0.90; Undocumented generalized variables Phil Sainty
2021-12-05  1:35 ` Lars Ingebrigtsen
2021-12-05  1:55   ` Michael Heerdegen
2021-12-05  2:00     ` Lars Ingebrigtsen
2021-12-05  2:25       ` Michael Heerdegen
2021-12-05  2:52         ` Lars Ingebrigtsen
2021-12-05 16:17           ` Michael Heerdegen
2021-12-05 20:43             ` Lars Ingebrigtsen
2021-12-05  2:09   ` Phil Sainty
2021-12-05  2:46     ` Lars Ingebrigtsen
2022-08-21 22:36       ` Lars Ingebrigtsen
2022-08-23  0:07         ` Michael Heerdegen
2022-08-23 10:41           ` Lars Ingebrigtsen
2022-08-31  2:10             ` Michael Heerdegen
2022-08-31  9:58               ` Lars Ingebrigtsen [this message]
2022-10-04 11:58         ` Lars Ingebrigtsen
2021-12-06  4:33 ` Richard Stallman

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=87o7w091ke.fsf@gnus.org \
    --to=larsi@gnus.org \
    --cc=52290@debbugs.gnu.org \
    --cc=michael_heerdegen@web.de \
    --cc=monnier@iro.umontreal.ca \
    --cc=psainty@orcon.net.nz \
    /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).