Small patch for ffap.el

* lisp/ffap.el (ffap-alist): Document that ffap sets the match data
while walking 'ffap-alist'.
This commit is contained in:
Philipp Stephani 2017-01-03 16:24:23 +00:00 committed by John Wiegley
parent 10444dcf77
commit 5c6f1198d4
No known key found for this signature in database
GPG key ID: C144D8F4F19FE630

View 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)