unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Stefan Monnier via "Bug reports for GNU Emacs, the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
To: Stefan Kangas <stefankangas@gmail.com>
Cc: Ihor Radchenko <yantar92@posteo.net>, 68370@debbugs.gnu.org
Subject: bug#68370: 30.0.50; pcase eieio, map, seq, and cl-struct constructs are not described in the manual
Date: Wed, 10 Jan 2024 11:19:13 -0500	[thread overview]
Message-ID: <jwv7ckh88oc.fsf-monnier+emacs@gnu.org> (raw)
In-Reply-To: <CADwFkm=dmUrKdSYRw=Bn8nd0Z49BE0Pe4jd8EjGwgXcp8=uqjw@mail.gmail.com> (Stefan Kangas's message of "Wed, 10 Jan 2024 06:56:41 -0800")

>> RMS recently pointed that `pcase' docstring describes map, seq, and
>> radix-tree-leaf constructs.
>>
>> However, they are not documented in the 11.4.1 The ‘pcase’ macro section
>> of Elisp manual.
>>
>> AFAIU, eieio, map, seq, cl-struct, and a number of other constructs
>> mentioned in the docstring are automatically added there by
>> `pcase-defmacro'.
>>
>> I see no need to document specialized pcase constructs like
>> `eshell-index-range', but eieie, map, seq, and cl-struct appears to be
>> matching common Elisp data structures. I think that they should be
>> documented in the manual.
>
> Copying in Stefan Monnier.

AFAIK these "belong" to `map.el`, `seq.el`, etc... so that's where they
should be documented.  The documentation for `pcase` could of course
include corresponding cross-references.


        Stefan






  reply	other threads:[~2024-01-10 16:19 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-01-10 12:46 bug#68370: 30.0.50; pcase eieio, map, seq, and cl-struct constructs are not described in the manual Ihor Radchenko
2024-01-10 14:56 ` Stefan Kangas
2024-01-10 16:19   ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors [this message]
2024-01-11 12:44     ` Ihor Radchenko
2024-01-12  3:06       ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-01-12 12:47         ` Ihor Radchenko
2024-01-13  3:54           ` Richard Stallman
2024-01-12  4:00     ` Richard Stallman
2024-01-13  3:50   ` Richard Stallman
2024-01-13 13:31     ` Ihor Radchenko
2024-01-11 19:09 ` Jim Porter
2024-01-12 23:07   ` Ihor Radchenko

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=jwv7ckh88oc.fsf-monnier+emacs@gnu.org \
    --to=bug-gnu-emacs@gnu.org \
    --cc=68370@debbugs.gnu.org \
    --cc=monnier@iro.umontreal.ca \
    --cc=stefankangas@gmail.com \
    --cc=yantar92@posteo.net \
    /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).