]> git.eshelyaron.com Git - emacs.git/commitdiff
Updater documentation of 'looking-back'
authorEli Zaretskii <eliz@gnu.org>
Wed, 13 Jan 2016 18:36:11 +0000 (20:36 +0200)
committerEli Zaretskii <eliz@gnu.org>
Wed, 13 Jan 2016 18:36:11 +0000 (20:36 +0200)
* doc/lispref/searching.texi (Regexp Search): Update documentation
of 'looking-back'.  Fix markup.

doc/lispref/searching.texi
etc/NEWS

index 5ff7ef1cf665082edd90d70d0aaaa83ba44bdaf1..1243d720bc30b80081eeeae22176c2ea49ead9d6 100644 (file)
@@ -1151,16 +1151,17 @@ comes back" twice.
 @end example
 @end defun
 
-@defun looking-back regexp &optional limit greedy
+@defun looking-back regexp limit &optional greedy
 This function returns @code{t} if @var{regexp} matches the text
 immediately before point (i.e., ending at point), and @code{nil} otherwise.
 
 Because regular expression matching works only going forward, this is
 implemented by searching backwards from point for a match that ends at
 point.  That can be quite slow if it has to search a long distance.
-You can bound the time required by specifying @var{limit}, which says
-not to search before @var{limit}.  In this case, the match that is
-found must begin at or after @var{limit}.  Here's an example:
+You can bound the time required by specifying a non-@code{nil} value
+for @var{limit}, which says not to search before @var{limit}.  In this
+case, the match that is found must begin at or after @var{limit}.
+Here's an example:
 
 @example
 @group
@@ -1178,9 +1179,9 @@ comes back" twice.
 
 If @var{greedy} is non-@code{nil}, this function extends the match
 backwards as far as possible, stopping when a single additional
-previous character cannot be part of a match for regexp.  When the
-match is extended, its starting position is allowed to occur before
-@var{limit}.
+previous character cannot be part of a match for @var{regexp}.  When
+the match is extended, its starting position is allowed to occur
+before @var{limit}.
 
 @c http://debbugs.gnu.org/5689
 As a general recommendation, try to avoid using @code{looking-back}
index c51136faf6328cd6d131d725b951f90790fa2a2b..7cea0c88da1a0f8e5d360020a976d5ca982cf754 100644 (file)
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -1353,7 +1353,9 @@ Previously, the default value of `nil' implied using `read'.
 ** New hook `pre-redisplay-functions'.
 It is a bit easier to use than `pre-redisplay-function'.
 
++++
 ** The second arg of `looking-back' should always be provided explicitly.
+Previously, it was an optional argument, now it's mandatory.
 
 ** Obsolete text properties `intangible', `point-entered', and `point-left'.
 Replaced by properties `cursor-intangible' and `cursor-sensor-functions',