GNU bug report logs - #43836
27.1; Doc string of `alist-get'

Previous Next

Full log

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

From: Drew Adams <drew.adams <at> oracle.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 27.1; Doc string of `alist-get'
Date: Tue, 6 Oct 2020 12:26:40 -0700 (PDT)

The doc string is less clear in 27.1 than it was in 26.3.

Instead of saying that a generalized variable is involved, it says:

  You can use `alist-get' in PLACE expressions.  This will modify
  an existing association (more precisely, the first one if
  multiple exist), or add a new element to the beginning of ALIST,
  destructively modifying the list stored in ALIST.

A user can a least look up "generalized variable" in Emacs 26.  The
Emacs 27 version just refers to "PLACE expressions", which is unclear
and can't be looked up easily.  And why is PLACE uppercase, which
indicates that it's something in the calling sequence or is otherwise
defined in the doc string somehow?

It's also not clear how _adding_ a new element to the beginning of ALIST
destructively modifies it.  Does it really mean setting the car of ALIST
to a different element, not adding an element?

Previous Next

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