diff options
author | Basil L. Contovounesios <contovob@tcd.ie> | 2020-05-28 00:12:54 +0100 |
---|---|---|
committer | Basil L. Contovounesios <contovob@tcd.ie> | 2020-05-28 00:12:54 +0100 |
commit | d0dd0e0612989ee169214e0f0ba32cf0a3e376b2 (patch) | |
tree | 9cf91048fff242003f4c899e21b71c41b1271bb4 /doc | |
parent | 313dc0439e9ed706c43eb5ba655719146d92a38f (diff) | |
download | emacs-d0dd0e0612989ee169214e0f0ba32cf0a3e376b2.tar.gz |
; Fix more @var/@code mixups in Elisp manual
* doc/lispref/text.texi (Replacing): Fix markup for function
arguments.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/lispref/text.texi | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi index f243cde9e8a..de436fa9e61 100644 --- a/doc/lispref/text.texi +++ b/doc/lispref/text.texi @@ -4511,33 +4511,33 @@ would destroy these properties. However, the latter combination is typically faster (@xref{Deletion}, and @ref{Insertion}). For its working, @code{replace-buffer-contents} needs to compare the -contents of the original buffer with that of @code{source} which is a +contents of the original buffer with that of @var{source} which is a costly operation if the buffers are huge and there is a high number of differences between them. In order to keep @code{replace-buffer-contents}'s runtime in bounds, it has two optional arguments. -@code{max-secs} defines a hard boundary in terms of seconds. If given +@var{max-secs} defines a hard boundary in terms of seconds. If given and exceeded, it will fall back to @code{delete-region} and @code{insert-buffer-substring}. -@code{max-costs} defines the quality of the difference computation. -If the actual costs exceed this limit, heuristics are used to provide -a faster but suboptimal solution. The default value is 1000000. +@var{max-costs} defines the quality of the difference computation. If +the actual costs exceed this limit, heuristics are used to provide a +faster but suboptimal solution. The default value is 1000000. @code{replace-buffer-contents} returns t if a non-destructive -replacement could be performed. Otherwise, i.e., if @code{max-secs} +replacement could be performed. Otherwise, i.e., if @var{max-secs} was exceeded, it returns nil. @end deffn @defun replace-region-contents beg end replace-fn &optional max-secs max-costs -This function replaces the region between @code{beg} and @code{end} -using the given @code{replace-fn}. The function @code{replace-fn} is +This function replaces the region between @var{beg} and @var{end} +using the given @var{replace-fn}. The function @var{replace-fn} is run in the current buffer narrowed to the specified region and it should return either a string or a buffer replacing the region. The replacement is performed using @code{replace-buffer-contents} (see -above) which also describes the @code{max-secs} and @code{max-costs} +above) which also describes the @var{max-secs} and @var{max-costs} arguments and the return value. Note: If the replacement is a string, it will be placed in a temporary |