unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: 31441@debbugs.gnu.org
Subject: bug#31441: 26; doc of functions `(lax-)plist-get'
Date: Sun, 13 May 2018 11:51:54 -0700 (PDT)	[thread overview]
Message-ID: <34003574-4449-428e-8ccd-7aa94d329ba5@default> (raw)

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).

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'.

2. "This function never signals an error.  This function does not change
   global state, including the match data."  If that is worth saying in
   the doc string (dunno) then it is worth saying in the manual,
   especially as the description of `lax-plist-get' says that it is like
   `plist-get' except for using `equal'.



In GNU Emacs 26.1 (build 1, x86_64-w64-mingw32)
 of 2018-04-10
Repository revision: c267421647510319d2a70554e42f0d1c394dba0a
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --without-dbus --host=x86_64-w64-mingw32
 --without-compress-install 'CFLAGS=-O2 -static -g3''





             reply	other threads:[~2018-05-13 18:51 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-05-13 18:51 Drew Adams [this message]
2019-07-13 14:43 ` bug#31441: 26; doc of functions `(lax-)plist-get' Lars Ingebrigtsen
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=34003574-4449-428e-8ccd-7aa94d329ba5@default \
    --to=drew.adams@oracle.com \
    --cc=31441@debbugs.gnu.org \
    /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).