diff options
| author | Basil L. Contovounesios | 2020-05-28 00:12:54 +0100 |
|---|---|---|
| committer | Basil L. Contovounesios | 2020-05-28 00:12:54 +0100 |
| commit | d0dd0e0612989ee169214e0f0ba32cf0a3e376b2 (patch) | |
| tree | 9cf91048fff242003f4c899e21b71c41b1271bb4 | |
| parent | 313dc0439e9ed706c43eb5ba655719146d92a38f (diff) | |
| download | emacs-d0dd0e0612989ee169214e0f0ba32cf0a3e376b2.tar.gz emacs-d0dd0e0612989ee169214e0f0ba32cf0a3e376b2.zip | |
; Fix more @var/@code mixups in Elisp manual
* doc/lispref/text.texi (Replacing): Fix markup for function
arguments.
| -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 | |||
| 4511 | typically faster (@xref{Deletion}, and @ref{Insertion}). | 4511 | typically faster (@xref{Deletion}, and @ref{Insertion}). |
| 4512 | 4512 | ||
| 4513 | For its working, @code{replace-buffer-contents} needs to compare the | 4513 | For its working, @code{replace-buffer-contents} needs to compare the |
| 4514 | contents of the original buffer with that of @code{source} which is a | 4514 | contents of the original buffer with that of @var{source} which is a |
| 4515 | costly operation if the buffers are huge and there is a high number of | 4515 | costly operation if the buffers are huge and there is a high number of |
| 4516 | differences between them. In order to keep | 4516 | differences between them. In order to keep |
| 4517 | @code{replace-buffer-contents}'s runtime in bounds, it has two | 4517 | @code{replace-buffer-contents}'s runtime in bounds, it has two |
| 4518 | optional arguments. | 4518 | optional arguments. |
| 4519 | 4519 | ||
| 4520 | @code{max-secs} defines a hard boundary in terms of seconds. If given | 4520 | @var{max-secs} defines a hard boundary in terms of seconds. If given |
| 4521 | and exceeded, it will fall back to @code{delete-region} and | 4521 | and exceeded, it will fall back to @code{delete-region} and |
| 4522 | @code{insert-buffer-substring}. | 4522 | @code{insert-buffer-substring}. |
| 4523 | 4523 | ||
| 4524 | @code{max-costs} defines the quality of the difference computation. | 4524 | @var{max-costs} defines the quality of the difference computation. If |
| 4525 | If the actual costs exceed this limit, heuristics are used to provide | 4525 | the actual costs exceed this limit, heuristics are used to provide a |
| 4526 | a faster but suboptimal solution. The default value is 1000000. | 4526 | faster but suboptimal solution. The default value is 1000000. |
| 4527 | 4527 | ||
| 4528 | @code{replace-buffer-contents} returns t if a non-destructive | 4528 | @code{replace-buffer-contents} returns t if a non-destructive |
| 4529 | replacement could be performed. Otherwise, i.e., if @code{max-secs} | 4529 | replacement could be performed. Otherwise, i.e., if @var{max-secs} |
| 4530 | was exceeded, it returns nil. | 4530 | was exceeded, it returns nil. |
| 4531 | @end deffn | 4531 | @end deffn |
| 4532 | 4532 | ||
| 4533 | @defun replace-region-contents beg end replace-fn &optional max-secs max-costs | 4533 | @defun replace-region-contents beg end replace-fn &optional max-secs max-costs |
| 4534 | This function replaces the region between @code{beg} and @code{end} | 4534 | This function replaces the region between @var{beg} and @var{end} |
| 4535 | using the given @code{replace-fn}. The function @code{replace-fn} is | 4535 | using the given @var{replace-fn}. The function @var{replace-fn} is |
| 4536 | run in the current buffer narrowed to the specified region and it | 4536 | run in the current buffer narrowed to the specified region and it |
| 4537 | should return either a string or a buffer replacing the region. | 4537 | should return either a string or a buffer replacing the region. |
| 4538 | 4538 | ||
| 4539 | The replacement is performed using @code{replace-buffer-contents} (see | 4539 | The replacement is performed using @code{replace-buffer-contents} (see |
| 4540 | above) which also describes the @code{max-secs} and @code{max-costs} | 4540 | above) which also describes the @var{max-secs} and @var{max-costs} |
| 4541 | arguments and the return value. | 4541 | arguments and the return value. |
| 4542 | 4542 | ||
| 4543 | Note: If the replacement is a string, it will be placed in a temporary | 4543 | Note: If the replacement is a string, it will be placed in a temporary |