Mercurial > emacs
changeset 55974:b8d3cea56c44
(format-insert-annotations, format-annotate-location): Doc fixes.
(format-subtract-regions): Make arguments match their use in docstring.
author | Juanma Barranquero <lekktu@gmail.com> |
---|---|
date | Mon, 07 Jun 2004 20:48:10 +0000 |
parents | a5892fa95ff4 |
children | 594a6cacebfe |
files | lisp/format.el |
diffstat | 1 files changed, 7 insertions(+), 5 deletions(-) [+] |
line wrap: on
line diff
--- a/lisp/format.el Mon Jun 07 20:44:24 2004 +0000 +++ b/lisp/format.el Mon Jun 07 20:48:10 2004 +0000 @@ -750,13 +750,15 @@ (message "Unknown annotations: %s" unknown-ans)))))) (defun format-subtract-regions (minu subtra) - "Remove from the regions in MINUend the regions in SUBTRAhend. + "Remove from the regions in MINUEND the regions in SUBTRAHEND. A region is a dotted pair (FROM . TO). Both parameters are lists of regions. Each list must contain nonoverlapping, noncontiguous regions, in descending order. The result is also nonoverlapping, noncontiguous, and in descending order. The first element of MINUEND can have a cdr of nil, indicating that the end of that region is not -yet known." +yet known. + +\(fn MINUEND SUBTRAHEND)" (let* ((minuend (copy-alist minu)) (subtrahend (copy-alist subtra)) (m (car minuend)) @@ -809,8 +811,8 @@ Inserts each element of the given LIST of buffer annotations at its appropriate place. Use second arg OFFSET if the annotations' locations are not relative to the beginning of the buffer: annotations will be inserted -at their location-OFFSET+1 \(ie, the offset is treated as the character number -of the first character in the buffer)." +at their location-OFFSET+1 \(ie, the offset is treated as the position of +the first character in the buffer)." (if (not offset) (setq offset 0) (setq offset (1- offset))) @@ -920,7 +922,7 @@ (defun format-annotate-location (loc all ignore translations) "Return annotation(s) needed at location LOC. -This includes any properties that change between LOC-1 and LOC. +This includes any properties that change between LOC - 1 and LOC. If ALL is true, don't look at previous location, but generate annotations for all non-nil properties. Third argument IGNORE is a list of text-properties not to consider.