unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Stefan Kangas <stefan@marxist.se>
To: Drew Adams <drew.adams@oracle.com>
Cc: "Mattias Engdegård" <mattiase@acm.org>, 46910@debbugs.gnu.org
Subject: bug#46910: 27.1; (elisp) RX doc
Date: Sat, 25 Sep 2021 08:25:38 -0700	[thread overview]
Message-ID: <CADwFkm=WsHnt55E0otrBLBjW_403TuGzL1o2h0gH_2pEWEX22A@mail.gmail.com> (raw)
In-Reply-To: <SA2PR10MB44741C1A010BB96CF0EA2152F3989@SA2PR10MB4474.namprd10.prod.outlook.com> (Drew Adams's message of "Wed, 3 Mar 2021 23:15:59 +0000")

Drew Adams <drew.adams@oracle.com> writes:

> 1. `Rx Constructs' doesn't explain that the "constructs" are used in
> arguments to macro `rx'.
>
> E.g.: "some-string" is not an RX expression.
>       (rx "some-string") is an RX expression.
>
> Please make this clear.
>
> 2. `Rx Constructs': Don't show things like `\sCODE' without saying what
> CODE means.  If the column title for the table explaining RX names is
> `Syntax character' or `Category character' then that's apparently what
> CODE corresponds to for `\sCODE' or `\cCODE'.  But there's no way to
> know that unless you're already familiar with `\s' and `\c' syntax.
>
> 3. `Rx Constructs', `Zero-width assertions': Call this `Zero-width
> matching' or some such.
>
> 4. `Rx Functions': RX-EXPR is used as parameter name for what is, I
> guess an Rx construct (the language used in `Rx Construct').  Expression
> or construct?  Make it clear that RX-EXPR is an RX construct, if that's
> what it is.  And consider adding an xref to `Rx Construct'.
>
> 5. `Rx Functions': A couple places talk about `'regexp' forms', but
> those are specified nowhere, AFAICT.  The same places talk about
> 'literal' forms, which are specified, but which don't seem to work (?).
> (See bug #46909.)

Mattias, is this perhaps something you could take a look at?  I guess
it's about (info "(elisp) Rx Notation").





  reply	other threads:[~2021-09-25 15:25 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-03 23:15 bug#46910: 27.1; (elisp) RX doc Drew Adams
2021-09-25 15:25 ` Stefan Kangas [this message]
2021-09-26 12:44   ` Mattias Engdegård

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='CADwFkm=WsHnt55E0otrBLBjW_403TuGzL1o2h0gH_2pEWEX22A@mail.gmail.com' \
    --to=stefan@marxist.se \
    --cc=46910@debbugs.gnu.org \
    --cc=drew.adams@oracle.com \
    --cc=mattiase@acm.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).