unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: dalanicolai <dalanicolai@gmail.com>
To: Michael Heerdegen <michael_heerdegen@web.de>
Cc: "Basil L. Contovounesios" <contovob@tcd.ie>, 47368@debbugs.gnu.org
Subject: bug#47368: 28.0.50; map-elt returns nil without "deprecated" TESTFN
Date: Thu, 25 Mar 2021 15:48:01 +0100	[thread overview]
Message-ID: <CACJP=3n7oRywQZt_zjkYwXng34VHk9fsfz2AL87jWyRC5vMuEg@mail.gmail.com> (raw)
In-Reply-To: <87lfacvtwt.fsf@web.de>

[-- Attachment #1: Type: text/plain, Size: 2198 bytes --]

For clarity I will insert the first lines of the docstrings here:

map-elt is a Lisp closure in ‘map.el’.
>
> (map-elt MAP KEY &optional DEFAULT)
>
>   Probably introduced at or before Emacs version 26.1.
>
> Lookup KEY in MAP and return its associated value.
> If KEY is not found, return DEFAULT which defaults to nil.
>
> TESTFN is deprecated.  Its default depends on the MAP argument.
>
> In the base definition, MAP can be an alist, plist, hash-table,
> or array.
>

First I agree with Michael that this docstring assumes a lot of knowledge
from the programmer.
The sentence "its default depends on the MAP argument" could be more
explicit, to make the docstring friendly to new elisp programmers.
e.g. mention eq for alists (and also the TESTFN's for the other ones)

Second calling the TESTFN deprecated is misleading if it a basic
requirement for the basic thing I am trying to achieve (i.e. matching a
string).
So it should probably mention that it is not required if you want to use
the MAP's default TESTFN, but otherwise it is required (while deprecated
sounds to me like there shouldn't be a need to use it)

Thanks for your answer!




On Thu, 25 Mar 2021 at 03:39, Michael Heerdegen <michael_heerdegen@web.de>
wrote:

> "Basil L. Contovounesios" <contovob@tcd.ie> writes:
>
> > dalanicolai <dalanicolai@gmail.com> writes:
> >
> > > The docstring of the map-elt function from the map.el package (version
> > > 3.0) mentions that TESTFN is deprecated because "its default depends on
> > > the MAP argument". However when I try e.g.
> > >
> > > (map-elt '(("A1" . 3)) "A1")
> > >
> > > it returns nil.
> >
> > This is expected, as alist keys are tested with eq by default.
> >
> > That's what the docstring is trying to warn about: alists default to
> > testing with eq, but can also use eql, equal, or anything else.
>
> Is it that obvious?  We have `assoc' and `assq' built-in - to me it's
> not obvious that "alist keys are tested with eq by default".  It's the
> default for `alist-get', ok, which is used by the implementation, but
> not everybody will know that.  I would add a sentence about that.
>
> Michael.
>

[-- Attachment #2: Type: text/html, Size: 3135 bytes --]

  reply	other threads:[~2021-03-25 14:48 UTC|newest]

Thread overview: 32+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-24 22:52 bug#47368: 28.0.50; map-elt returns nil without "deprecated" TESTFN dalanicolai
2021-03-24 23:24 ` Basil L. Contovounesios
2021-03-25  2:39   ` Michael Heerdegen
2021-03-25 14:48     ` dalanicolai [this message]
2021-03-25 15:33     ` bug#47368: [External] : " Drew Adams
2021-03-26 18:47       ` Basil L. Contovounesios
2021-03-26 20:04         ` Drew Adams
2021-03-26 20:23           ` Basil L. Contovounesios
2021-03-26 22:40             ` Drew Adams
2021-03-26 22:59               ` Basil L. Contovounesios
2021-03-26  3:59     ` Michael Heerdegen
2021-03-26  7:38       ` dalanicolai
2021-03-26 13:31       ` Stefan Monnier
2021-03-26 15:32         ` dalanicolai
2021-03-26 18:57         ` Basil L. Contovounesios
2021-03-26 23:18           ` Michael Heerdegen
2021-03-27 20:37           ` Basil L. Contovounesios
2021-03-26 23:23         ` Michael Heerdegen
2021-03-26 18:58     ` Basil L. Contovounesios
2021-07-21 15:34 ` Adam Porter
2021-07-22  2:15   ` Michael Heerdegen
2021-07-31  2:15     ` Michael Heerdegen
2021-09-13 14:06       ` Adam Porter
2021-09-14 14:40         ` Michael Heerdegen
2021-09-14 20:22           ` Basil L. Contovounesios via Bug reports for GNU Emacs, the Swiss army knife of text editors
2021-09-15  0:48             ` Michael Heerdegen
2021-09-15  9:26               ` Basil L. Contovounesios via Bug reports for GNU Emacs, the Swiss army knife of text editors
2021-09-15 12:39               ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2021-09-15 21:53                 ` Michael Heerdegen
2021-09-15 12:50             ` Basil L. Contovounesios via Bug reports for GNU Emacs, the Swiss army knife of text editors
2021-09-15 21:55               ` Michael Heerdegen
2021-09-21 12:42                 ` Basil L. Contovounesios via Bug reports for GNU Emacs, the Swiss army knife of text editors

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='CACJP=3n7oRywQZt_zjkYwXng34VHk9fsfz2AL87jWyRC5vMuEg@mail.gmail.com' \
    --to=dalanicolai@gmail.com \
    --cc=47368@debbugs.gnu.org \
    --cc=contovob@tcd.ie \
    --cc=michael_heerdegen@web.de \
    /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).