mirror/emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-11-28 07:45:00 +00:00
Code Issues Releases Activity

Expand the `match-string' doc string

Browse Source 
* lisp/subr.el (match-string): Mention some caveats (bug#34214).
This commit is contained in:
Lars Ingebrigtsen 2021-09-23 00:09:47 +02:00
parent bb3a045501
commit 866c1f56a3
1 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
lisp/subr.el
View File

@ -4667,13 +4667,23 @@ rather than your caller's match data."
'(set-match-data save-match-data-internal 'evaporate))))
(defun match-string (num &optional string)
"Return string of text matched by last search.
"Return the string of text matched by the previous search or regexp operation.
NUM specifies which parenthesized expression in the last regexp.
Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
Zero means the entire text matched by the whole regexp or whole string.
STRING should be given if the last search was by `string-match' on STRING.
If STRING is nil, the current buffer should be the same buffer
the search/match was performed in."
The return value is nil if NUMth pair didn't match, or there were
less than NUM pairs.
STRING should be given if the last search was by `string-match'
on STRING. If STRING is nil, the current buffer should be the
same buffer the search/match was performed in.
Note that many functions in Emacs modify the match data, so this
function should be called \"close\" to the function that did the
match. In particular, saying (for instance)
`M-: (looking-at \"[0-9]\") RET' followed by `M-: (match-string 0) RET'
interactively is seldom meaningful, since the Emacs command loop
may modify the match data."
(declare (side-effect-free t))
(if (match-beginning num)
(if string