emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/xr 9d9debd 5/9: Remove package description in xr.el


From: Mattias Engdegård
Subject: [elpa] externals/xr 9d9debd 5/9: Remove package description in xr.el
Date: Sat, 29 Feb 2020 17:22:12 -0500 (EST)

branch: externals/xr
commit 9d9debdc01a87abbdd09ee951699d839737bd7b3
Author: Mattias Engdegård <address@hidden>
Commit: Mattias Engdegård <address@hidden>

    Remove package description in xr.el
    
    Refer to the README file instead. There is no reason for the redundancy.
---
 xr.el | 58 +++-------------------------------------------------------
 1 file changed, 3 insertions(+), 55 deletions(-)

diff --git a/xr.el b/xr.el
index fc5c7f7..c32ae7f 100644
--- a/xr.el
+++ b/xr.el
@@ -23,61 +23,9 @@
 
 ;;; Commentary:
 
-;; This is an inverse companion to the rx package for translating
-;; regexps in string form to the rx notation.  Its chief uses are:
-;;
-;; - Migrating existing code to rx form, for better readability and
-;;   maintainability
-;; - Understanding complex regexp strings and finding errors in them
-;;   
-;; Please refer to `rx' for more information about the notation.
-;;
-;; In addition to Emacs regexps, this package can also parse and
-;; find mistakes in skip set strings, which are arguments to
-;; `skip-chars-forward' and `skip-chars-backward'.
-;;
-;; The exported functions are:
-;;
-;;  Regexps:
-;;  `xr'               - returns the converted rx expression
-;;  `xr-pp'            - converts to rx and pretty-prints
-;;  `xr-lint'          - finds mistakes in a regexp string
-;;
-;;  Skip sets:
-;;  `xr-skip-set'      - return the converted rx expression
-;;  `xr-skip-set-pp'   - converts to rx and pretty-prints
-;;  `xr-skip-set-lint' - finds mistakes in a skip set string
-;;
-;;  General:
-;;  `xr-pp-rx-to-str'  - pretty-prints an rx expression to a string
-;;
-;; Example (regexp found in compile.el):
-;;
-;;   (xr-pp "\\`\\(?:[^^]\\|\\^\\(?: \\*\\|\\[\\)\\)")
-;; =>
-;;   (seq bos
-;;        (or (not (any "^"))
-;;            (seq "^"
-;;                 (or " *" "["))))
-;;
-;; The rx notation admits many synonyms. The user is encouraged to
-;; edit the result for maximum readability, consistency and personal
-;; preference when replacing existing regexps in elisp code.
-;;
-;; Related work:
-;;
-;; The `lex' package, a lexical analyser generator, provides the
-;; `lex-parse-re' function which translates regexps to rx, but does
-;; not attempt to handle all the edge cases of Elisp's regexp syntax
-;; or pretty-print the result.
-;;
-;; The `pcre2el' package, a regexp syntax converter and interactive
-;; regexp explainer, could also be used for translating regexps to rx.
-;; `xr' is narrower in scope but more accurate for the purpose of
-;; parsing Emacs regexps and printing the results in rx form.
-;;
-;; Neither of these packages parse skip-set strings or provide
-;; mistake-finding functions.
+;; This package translates regexps in string form to the rx notation.
+;; It can also find mistakes and questionable constructs in regexps
+;; and related expressions. See the README file for more information.
 
 ;;; News:
 



reply via email to

[Prev in Thread] Current Thread [Next in Thread]