From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Lars Ingebrigtsen Newsgroups: gmane.emacs.bugs Subject: bug#31441: 26; doc of functions `(lax-)plist-get' Date: Sat, 13 Jul 2019 16:43:37 +0200 Message-ID: <87pnmeuh9i.fsf@mouse.gnus.org> References: <34003574-4449-428e-8ccd-7aa94d329ba5@default> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="177716"; mail-complaints-to="usenet@blaine.gmane.org" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.0.50 (gnu/linux) Cc: 31441@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sat Jul 13 16:59:46 2019 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([209.51.188.17]) by blaine.gmane.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.89) (envelope-from ) id 1hmJV4-000jon-7f for geb-bug-gnu-emacs@m.gmane.org; Sat, 13 Jul 2019 16:59:46 +0200 Original-Received: from localhost ([::1]:56646 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hmJFy-0000WZ-1i for geb-bug-gnu-emacs@m.gmane.org; Sat, 13 Jul 2019 10:44:10 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:49275) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hmJFu-0000UM-8H for bug-gnu-emacs@gnu.org; Sat, 13 Jul 2019 10:44:07 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hmJFs-0006pS-6c for bug-gnu-emacs@gnu.org; Sat, 13 Jul 2019 10:44:06 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:34226) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1hmJFq-0006ns-6M for bug-gnu-emacs@gnu.org; Sat, 13 Jul 2019 10:44:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1hmJFp-0000or-T0 for bug-gnu-emacs@gnu.org; Sat, 13 Jul 2019 10:44:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Lars Ingebrigtsen Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 13 Jul 2019 14:44:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 31441 X-GNU-PR-Package: emacs Original-Received: via spool by 31441-submit@debbugs.gnu.org id=B31441.15630290233102 (code B ref 31441); Sat, 13 Jul 2019 14:44:01 +0000 Original-Received: (at 31441) by debbugs.gnu.org; 13 Jul 2019 14:43:43 +0000 Original-Received: from localhost ([127.0.0.1]:43044 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1hmJFX-0000ny-Io for submit@debbugs.gnu.org; Sat, 13 Jul 2019 10:43:43 -0400 Original-Received: from quimby.gnus.org ([80.91.231.51]:35004) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1hmJFW-0000nq-1v for 31441@debbugs.gnu.org; Sat, 13 Jul 2019 10:43:42 -0400 Original-Received: from cm-84.212.202.86.getinternet.no ([84.212.202.86] helo=marnie) by quimby.gnus.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.89) (envelope-from ) id 1hmJFR-0001Va-Lb; Sat, 13 Jul 2019 16:43:40 +0200 In-Reply-To: <34003574-4449-428e-8ccd-7aa94d329ba5@default> (Drew Adams's message of "Sun, 13 May 2018 11:51:54 -0700 (PDT)") X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 209.51.188.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:162899 Archived-At: Drew Adams 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