GNU bug report logs - #36496
[PATCH] Describe the rx notation in the lisp manual

Previous Next

Package: emacs;

Reported by: Mattias Engdegård <mattiase <at> acm.org>

Date: Thu, 4 Jul 2019 12:14:01 UTC

Severity: wishlist

Merged with 31698

Found in version 27.0

Done: Lars Ingebrigtsen <larsi <at> gnus.org>

Bug is archived. No further changes may be made.

Full log

View this message in rfc822 format

From: Mattias Engdegård <mattiase <at> acm.org>
To: 36496 <at> debbugs.gnu.org
Subject: bug#36496: [PATCH] Describe the rx notation in the lisp manual
Date: Thu, 4 Jul 2019 14:13:26 +0200

[Message part 1 (text/plain, inline)]
The rx notation is useful and complex enough to merit inclusion in the manual.

Right now, it's mainly described in the `rx' doc string, which is fairly well-written but quite long and a bit unstructured. Describing it in the manual permits a different pace and style of exposition, the inclusion of examples and related information, structured into separate sections with cross-references.

Proposed patch attached. It covers all rx features, functions, macros, including the pcase pattern, and a mention of the corresponding string regexp constructs.

The existing `rx' doc string can be left unchanged, or reduced to something more concise, perhaps without a description of the entire rx language but with a manual reference. Suggestions are welcome.


[0001-Describe-the-rx-notation-in-the-elisp-manual.patch (application/octet-stream, attachment)]
This bug report was last modified 3 years and 21 days ago.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.