Commit e73adad8 authored by Tassilo Horn's avatar Tassilo Horn

; Fixup docs for replace-{buffer,region}-contents

parent 3ec62eec
Pipeline #860 passed with stage
in 59 minutes and 47 seconds
...@@ -4468,18 +4468,18 @@ If the actual costs exceed this limit, heuristics are used to provide ...@@ -4468,18 +4468,18 @@ If the actual costs exceed this limit, heuristics are used to provide
a faster but suboptimal solution. The default value is 1000000. a faster but suboptimal solution. The default value is 1000000.
@code{replace-buffer-contents} returns t if a non-destructive @code{replace-buffer-contents} returns t if a non-destructive
replacement could be performed. Otherwise, i.e., if MAX-SECS was replacement could be performed. Otherwise, i.e., if @code{max-secs}
exceeded, it returns nil. was exceeded, it returns nil.
@end deffn @end deffn
@deffn Command replace-region-contents beg end replace-fn &optional max-secs max-costs @defun replace-region-contents beg end replace-fn &optional max-secs max-costs
This function replaces the region between @code{beg} and @code{end} This function replaces the region between @code{beg} and @code{end}
using the given @code{replace-fn}. The function @code{replace-fn} is using the given @code{replace-fn}. The function @code{replace-fn} is
run in the current buffer narrowed to the specified region and it run in the current buffer narrowed to the specified region and it
should return either a string or a buffer replacing the region. should return either a string or a buffer replacing the region.
The replacement is performed using @code{replace-buffer-contents} The replacement is performed using @code{replace-buffer-contents} (see
which also describes the @code{max-secs} and @code{max-costs} above) which also describes the @code{max-secs} and @code{max-costs}
arguments and the return value. arguments and the return value.
Note: If the replacement is a string, it will be placed in a temporary Note: If the replacement is a string, it will be placed in a temporary
...@@ -4487,7 +4487,7 @@ buffer so that @code{replace-buffer-contents} can operate on it. ...@@ -4487,7 +4487,7 @@ buffer so that @code{replace-buffer-contents} can operate on it.
Therefore, if you already have the replacement in a buffer, it makes Therefore, if you already have the replacement in a buffer, it makes
no sense to convert it to a string using @code{buffer-substring} or no sense to convert it to a string using @code{buffer-substring} or
similar. similar.
@end deffn @end defun
@node Decompression @node Decompression
@section Dealing With Compressed Data @section Dealing With Compressed Data
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment