bug#46910: 27.1; (elisp) RX doc

[Mattias Engdegård]

25 sep. 2021 kl. 17.25 skrev Stefan Kangas <stefan@marxist.se>:
> 
> Drew Adams <drew.adams@oracle.com> writes:
> 
>> 1. `Rx Constructs' doesn't explain that the "constructs" are used in
>> arguments to macro `rx'.

Yes, I've added an explanation.

>> 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.

That's a valid point; now elaborated.

If anything I'd like to move the tables of syntax and (especially) category 
names to a separate page since they are rarely consulted and take up a lot of 
space. Not sure how to best do that.

>> 3. `Rx Constructs', `Zero-width assertions': Call this `Zero-width
>> matching' or some such.

Thank you, but it's established terminology and immediately explained in the 
first sentence.

>> 4. `Rx Functions': RX-EXPR is used as parameter name for what is, I
>> guess an Rx construct

That was a clear mistake, now fixed -- thanks.

>> 5. `Rx Functions': A couple places talk about `'regexp' forms', but
>> those are specified nowhere

The `regexp` and `literal` forms are both documented on the previous page.

For good measure, I also added some examples to illustrate the difference 
between `rx` and `rx-to-string`.