From: Lars Ingebrigtsen <larsi@gnus.org>
To: Drew Adams <drew.adams@oracle.com>
Cc: 31441@debbugs.gnu.org
Subject: bug#31441: 26; doc of functions `(lax-)plist-get'
Date: Sat, 13 Jul 2019 16:43:37 +0200 [thread overview]
Message-ID: <87pnmeuh9i.fsf@mouse.gnus.org> (raw)
In-Reply-To: <34003574-4449-428e-8ccd-7aa94d329ba5@default> (Drew Adams's message of "Sun, 13 May 2018 11:51:54 -0700 (PDT)")
Drew Adams <drew.adams@oracle.com> writes:
> The doc in (elisp) `Plist Access' is mostly OK, but it could
> be improved. The doc strings of these two functions are not OK.
>
> The doc strings need to point out, as does the manual, that `plist-get'
> uses `eq' and `lax-plist-get' uses `equal'. In addition, the doc string
> of `lax-plist-get' should, like the manual, say that it is in all other
> respects just like `plist-get' (providing a link to that function's
> description).
I've now done these things, except that (weirdly enough) lax-plist-get
is not like plist-get in all other respects -- plist-get will never
signal an error, while lax-plist-get may signal an error if PLIST isn't
a valid plist. *sigh*
> In addition the manual description of `plist-get' could be improved by
> mentioning these two things, which are mentioned by its doc string:
>
> 1. It uses `eq'. (If one reads further then this becomes apparent when
> reading about `lax-plist-get'.
The manual says (right above plist-get):
They all compare property names using @code{eq}.
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no
next prev parent reply other threads:[~2019-07-13 14:43 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-05-13 18:51 bug#31441: 26; doc of functions `(lax-)plist-get' Drew Adams
2019-07-13 14:43 ` Lars Ingebrigtsen [this message]
2019-07-13 17:31 ` Drew Adams
2019-07-13 18:31 ` Pip Cet
2019-07-13 19:14 ` 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
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=87pnmeuh9i.fsf@mouse.gnus.org \
--to=larsi@gnus.org \
--cc=31441@debbugs.gnu.org \
--cc=drew.adams@oracle.com \
/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).