mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-01-05 19:31:02 -08:00
Code Issues Projects Releases Wiki Activity

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

Browse source 
* 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 17:19:36 +01:00
parent 2e2a806803
commit 8dd624c8ac
1 changed files with 4 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

5
lisp/ffap.el
View file

@ -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 symbol, and it equals `major-mode', or
KEY is a string, it should match NAME as a regexp. KEY is a string, it should match NAME as a regexp.
On a match, (FUNCTION NAME) is called and should return a file, an 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) (put 'ffap-alist 'risky-local-variable t)