]> git.eshelyaron.com Git - emacs.git/commitdiff
Regexp Functions doc minor fixes
authorPaul Eggert <eggert@cs.ucla.edu>
Tue, 27 Sep 2016 00:00:03 +0000 (17:00 -0700)
committerPaul Eggert <eggert@cs.ucla.edu>
Tue, 27 Sep 2016 00:01:09 +0000 (17:01 -0700)
* doc/lispref/searching.texi (Regexp Functions):
Fix misspelling of “matching”.  Use @table for table.
Reformat code example to fit into info file width (Bug#17862).

doc/lispref/searching.texi

index a335e89985fd56d4c954d4b3ba0c1e89f061a25b..579460f3227734bcd9668220e2dab585c40d4089 100644 (file)
@@ -950,37 +950,41 @@ more efficient, but is almost never worth the effort.}.
 
 The optional argument @var{paren} can be any of the following:
 
-a string
-    the resulting regexp is preceded by @var{paren} and followed by
-    @samp{\)}, e.g. use @samp{"\\(?1:"} to produce an explicitly
-    numbered group.
+@table @asis
+@item a string
+The resulting regexp is preceded by @var{paren} and followed by
+@samp{\)}, e.g. use @samp{"\\(?1:"} to produce an explicitly
+numbered group.
 
-@code{words}
-    the resulting regexp is surrounded by @samp{\<\(} and @samp{\)\>}.
+@item @code{words}
+The resulting regexp is surrounded by @samp{\<\(} and @samp{\)\>}.
 
-@code{symbols}
-    the resulting regexp is surrounded by @samp{\_<\(} and @samp{\)\_>}
-    (this is often appropriate when maching programming-language
-    keywords and the like).
+@item @code{symbols}
+The resulting regexp is surrounded by @samp{\_<\(} and @samp{\)\_>}
+(this is often appropriate when matching programming-language
+keywords and the like).
 
-non-@code{nil}
-    the resulting regexp is surrounded by @samp{\(} and @samp{\)}.
+@item non-@code{nil}
+The resulting regexp is surrounded by @samp{\(} and @samp{\)}.
 
-@code{nil}
-    the resulting regexp is surrounded by @samp{\(?:} and @samp{\)},
-    if it is necessary to ensure that a postfix operator appended to
-    it will apply to the whole expression.
+@item @code{nil}
+The resulting regexp is surrounded by @samp{\(?:} and @samp{\)},
+if it is necessary to ensure that a postfix operator appended to
+it will apply to the whole expression.
+@end table
 
 The resulting regexp of @code{regexp-opt} is equivalent to but usually
 more efficient than that of a simplified version:
 
 @example
 (defun simplified-regexp-opt (strings &optional paren)
- (let ((parens (cond ((stringp paren)       (cons paren "\\)"))
-                     ((eq paren 'words)    '("\\<\\(" . "\\)\\>"))
-                     ((eq paren 'symbols) '("\\_<\\(" . "\\)\\_>"))
-                     ((null paren)          '("\\(?:" . "\\)"))
-                     (t                       '("\\(" . "\\)")))))
+ (let ((parens
+        (cond
+         ((stringp paren)       (cons paren "\\)"))
+         ((eq paren 'words)    '("\\<\\(" . "\\)\\>"))
+         ((eq paren 'symbols) '("\\_<\\(" . "\\)\\_>"))
+         ((null paren)          '("\\(?:" . "\\)"))
+         (t                       '("\\(" . "\\)")))))
    (concat (car paren)
            (mapconcat 'regexp-quote strings "\\|")
            (cdr paren))))