From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.bugs Subject: bug#31441: 26; doc of functions `(lax-)plist-get' Date: Sun, 13 May 2018 11:51:54 -0700 (PDT) Message-ID: <34003574-4449-428e-8ccd-7aa94d329ba5@default> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable X-Trace: blaine.gmane.org 1526237470 14449 195.159.176.226 (13 May 2018 18:51:10 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Sun, 13 May 2018 18:51:10 +0000 (UTC) To: 31441@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sun May 13 20:51:05 2018 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1fHw5G-0003d9-71 for geb-bug-gnu-emacs@m.gmane.org; Sun, 13 May 2018 20:51:02 +0200 Original-Received: from localhost ([::1]:58154 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fHw7N-0003IM-CK for geb-bug-gnu-emacs@m.gmane.org; Sun, 13 May 2018 14:53:13 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:60331) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fHw7G-0002jE-Ru for bug-gnu-emacs@gnu.org; Sun, 13 May 2018 14:53:07 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1fHw7C-000464-0J for bug-gnu-emacs@gnu.org; Sun, 13 May 2018 14:53:06 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:53110) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1fHw7B-00045y-Ru for bug-gnu-emacs@gnu.org; Sun, 13 May 2018 14:53:01 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1fHw7B-0001MK-L2 for bug-gnu-emacs@gnu.org; Sun, 13 May 2018 14:53:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Drew Adams Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 13 May 2018 18:53:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 31441 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.15262375375164 (code B ref -1); Sun, 13 May 2018 18:53:01 +0000 Original-Received: (at submit) by debbugs.gnu.org; 13 May 2018 18:52:17 +0000 Original-Received: from localhost ([127.0.0.1]:32774 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1fHw6T-0001LD-4k for submit@debbugs.gnu.org; Sun, 13 May 2018 14:52:17 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:40924) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1fHw6P-0001Kz-UN for submit@debbugs.gnu.org; Sun, 13 May 2018 14:52:14 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1fHw6K-0003uj-1J for submit@debbugs.gnu.org; Sun, 13 May 2018 14:52:08 -0400 Original-Received: from lists.gnu.org ([2001:4830:134:3::11]:35502) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1fHw6J-0003ua-UN for submit@debbugs.gnu.org; Sun, 13 May 2018 14:52:07 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:60121) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fHw6I-0000Vl-MA for bug-gnu-emacs@gnu.org; Sun, 13 May 2018 14:52:07 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1fHw6D-0003tr-QU for bug-gnu-emacs@gnu.org; Sun, 13 May 2018 14:52:06 -0400 Original-Received: from aserp2120.oracle.com ([141.146.126.78]:46910) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1fHw6D-0003tb-F0 for bug-gnu-emacs@gnu.org; Sun, 13 May 2018 14:52:01 -0400 Original-Received: from pps.filterd (aserp2120.oracle.com [127.0.0.1]) by aserp2120.oracle.com (8.16.0.22/8.16.0.22) with SMTP id w4DImENe156673 for ; Sun, 13 May 2018 18:51:58 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oracle.com; h=mime-version : message-id : date : from : sender : to : subject : content-type : content-transfer-encoding; s=corp-2017-10-26; bh=JPDAdaQ4G2deX04NLkGWakHrwpn+Eme2ZNtzg895W2A=; b=EsiDRdjXhTHNyI/qrbqv/NElYQzbXZOkZ+CGCsTu5eUoqD+3H1hTLI5O3nu6DX5CGoL9 Ie7ZneUJlnvYT9fHrBDH5A/KE6VXdEyYto3i58NvIXWDl27mLkixlWPmJCF5DLmmYL7t 6O+OdyF8lnlwFQt2sBCsM1qSBZC1YXDFdfutlvoY9ZXuuwaYsXcrFi5E+2EXBJwbVLBI r4EFPcOGkFeim8tdT0UZNAPTBUMrTzppjgWIM6kUW4ZfpktFVX/XtPh7Xvkg6znhanB6 77XAppbKJTH/MGZjLAms9H30w70a/Mzs7UMvH3ngwt0dwIFn+aGjmK+qOn5E9xzGWtWa MA== Original-Received: from userv0021.oracle.com (userv0021.oracle.com [156.151.31.71]) by aserp2120.oracle.com with ESMTP id 2hx29vsmj9-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK) for ; Sun, 13 May 2018 18:51:58 +0000 Original-Received: from aserv0121.oracle.com (aserv0121.oracle.com [141.146.126.235]) by userv0021.oracle.com (8.14.4/8.14.4) with ESMTP id w4DIpupZ021165 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK) for ; Sun, 13 May 2018 18:51:57 GMT Original-Received: from abhmp0001.oracle.com (abhmp0001.oracle.com [141.146.116.7]) by aserv0121.oracle.com (8.14.4/8.13.8) with ESMTP id w4DIpuZ4023398 for ; Sun, 13 May 2018 18:51:56 GMT X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9.1 (1003210) [OL 16.0.4690.0 (x86)] X-Proofpoint-Virus-Version: vendor=nai engine=5900 definitions=8892 signatures=668698 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 suspectscore=1 malwarescore=0 phishscore=0 bulkscore=0 spamscore=0 mlxscore=0 mlxlogscore=588 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1711220000 definitions=main-1805130195 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x [generic] [fuzzy] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6.x 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: 208.118.235.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:146156 Archived-At: 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=3Dx86_64-w64-mingw32 --without-compress-install 'CFLAGS=3D-O2 -static -g3''