From: Philipp Stephani <phst@google.com>
Date: Tue, 3 Jan 2017 16:19:36 +0000 (+0100)
Subject: Document that functions in 'ffap-alist' can use the match data
X-Git-Tag: emacs-25.2-rc1~41
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=8dd624c8ac179d5381e00c04358d353866f60f9f;p=emacs.git

Document that functions in 'ffap-alist' can use the match data

* lisp/ffap.el (ffap-alist): Document that ffap sets the match data
while walking 'ffap-alist'.
---

diff --git a/lisp/ffap.el b/lisp/ffap.el
index 76e86ef9511..c1fab70fe94 100644
--- a/lisp/ffap.el
+++ b/lisp/ffap.el
@@ -792,7 +792,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)