]> git.eshelyaron.com Git - emacs.git/commitdiff
Small patch for ffap.el
authorPhilipp Stephani <p.stephani2@gmail.com>
Tue, 3 Jan 2017 16:24:23 +0000 (16:24 +0000)
committerJohn Wiegley <johnw@newartisans.com>
Tue, 3 Jan 2017 16:40:57 +0000 (08:40 -0800)
* lisp/ffap.el (ffap-alist): Document that ffap sets the match data
while walking 'ffap-alist'.

lisp/ffap.el

index cabf33950122f2884e1a2763006a67adfea9da53..8144d41f3a1e21f7740ff63f06ed6b3eae7ea2b8 100644 (file)
@@ -797,7 +797,10 @@ specify actions to try creating such a string.  A pair matches if either
   KEY is a symbol, and it equals `major-mode', or
   KEY is a string, it should match NAME as a regexp.
 On a match, (FUNCTION NAME) is called and should return a file, an
-URL, or nil.  If nil, search the alist for further matches.")
+URL, or nil.  If nil, search the alist for further matches.
+While calling FUNCTION, the match data is set according to KEY if KEY
+is a string, so that FUNCTION can use `match-string' and friends
+to extract substrings.")
 
 (put 'ffap-alist 'risky-local-variable t)