From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Thien-Thi Nguyen Newsgroups: gmane.emacs.bugs Subject: bug#31311: 27.0; doc of `pcase' Date: Mon, 30 Apr 2018 09:48:15 +0200 Message-ID: <87k1sp5e4g.fsf@gnuvola.org> References: <87vac9k04a.fsf@web.de> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: multipart/signed; boundary="=-=-="; micalg=pgp-sha1; protocol="application/pgp-signature" X-Trace: blaine.gmane.org 1525091918 31582 195.159.176.226 (30 Apr 2018 12:38:38 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Mon, 30 Apr 2018 12:38:38 +0000 (UTC) User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.0.50 (gnu/linux) Cc: 31311@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Mon Apr 30 14:38:34 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 1fD84f-00088u-HH for geb-bug-gnu-emacs@m.gmane.org; Mon, 30 Apr 2018 14:38:33 +0200 Original-Received: from localhost ([::1]:59582 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fD86m-0002FH-IY for geb-bug-gnu-emacs@m.gmane.org; Mon, 30 Apr 2018 08:40:44 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:50618) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fD84E-0000KY-3n for bug-gnu-emacs@gnu.org; Mon, 30 Apr 2018 08:38:07 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1fD84A-0002w0-WC for bug-gnu-emacs@gnu.org; Mon, 30 Apr 2018 08:38:06 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:35628) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1fD84A-0002vt-SP for bug-gnu-emacs@gnu.org; Mon, 30 Apr 2018 08:38:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1fD84A-0001Z5-Ml for bug-gnu-emacs@gnu.org; Mon, 30 Apr 2018 08:38:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Thien-Thi Nguyen Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 30 Apr 2018 12:38:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 31311 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 31311-submit@debbugs.gnu.org id=B31311.15250918345944 (code B ref 31311); Mon, 30 Apr 2018 12:38:02 +0000 Original-Received: (at 31311) by debbugs.gnu.org; 30 Apr 2018 12:37:14 +0000 Original-Received: from localhost ([127.0.0.1]:43522 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1fD83O-0001Xn-3Q for submit@debbugs.gnu.org; Mon, 30 Apr 2018 08:37:14 -0400 Original-Received: from mail.agora-net.com ([67.59.132.6]:40348) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1fD83M-0001XY-2F for 31311@debbugs.gnu.org; Mon, 30 Apr 2018 08:37:12 -0400 Original-Received: from ttn by mail.agora-net.com with local (Exim 4.82) (envelope-from ) id 1fD83L-0008BC-CO; Mon, 30 Apr 2018 08:37:11 -0400 Original-Received: from ttn by zigzag.favinet with local (Exim 4.80) (envelope-from ) id 1fD3Xs-00025h-NZ; Mon, 30 Apr 2018 09:48:24 +0200 In-Reply-To: (Drew Adams's message of "Sun, 29 Apr 2018 19:47:08 -0700 (PDT)") X-SA-Exim-Connect-IP: X-SA-Exim-Mail-From: ttn@gnuvola.org X-SA-Exim-Scanned: No (on mail.agora-net.com); SAEximRunCond expanded to false 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:145858 Archived-At: --=-=-= Content-Type: text/plain Content-Transfer-Encoding: quoted-printable () Drew Adams () Sun, 29 Apr 2018 19:47:08 -0700 (PDT) > > 2. Don't use ATOM [...] >=20 > "ATOM can be a keyword, an integer, or a string". In > particular, floats are excluded. nil and t are also > excluded. "KEYWORD-OR-INTEGER-OR-STRING" is not a good > name, however. It may not be a good name, but it is not so misleading. And it's not used in a zillion places, so it's not a big deal if the name is long: INTEGER-STRING-OR-KEYWORD or even perhaps INTEGER|STRING|KEYWORD. We have much longer stuff in the description of font-lock stuff and elsewhere. Complex things need careful breakdowns and named parts. "Atom", without that qualification, includes lots of other things, including vectors and, in particular, symbols. Since "atom" is a shorthand for this set of types in an @item context, another solution is to list the types explicitly: @item @var{integer} @itemx @var{string} @itemx @var{keyword} These types are self-quoting [...] In this way, we achieve grouping through presentation and not through coining (possibly confusing) terms. This makes the text longer vertically, but flattens the conceptual model (for this particular grouping of types) for the reader, who can mentally coin terms on their own, like "!@#$%-complicated-sh*t". :-D Oh, and do the other two occurrences of ATOM - those in the description of Q-patterns - mean the same thing: keyword, string, or integer? Nothing said about that; not clear. Same technique applicable, here. Generally, it's good to use abstractions in code (DRY principle), but for documentation, a flatter landscape w/ simple landmarks is easier to navigate. This is one of the sadnesses i have come to realize as a programmer trying to communicate w/ non-programmers. =2D-=20 Thien-Thi Nguyen ----------------------------------------------- (defun responsep (query) (pcase (context query) (`(technical ,ml) (correctp ml)) ...)) 748E A0E8 1CB8 A748 9BFA =2D-------------------------------------- 6CE4 6703 2224 4C80 7502 --=-=-= Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.12 (GNU/Linux) iEYEARECAAYFAlrmykIACgkQZwMiJEyAdQLnvwCghFHbXsr69DKopuVv+qEzezpV 5N4AniOHKHhfGeDsiC0h5LeooC7i0nGk =nhV1 -----END PGP SIGNATURE----- --=-=-=--