aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJuanma Barranquero2004-06-07 20:48:10 +0000
committerJuanma Barranquero2004-06-07 20:48:10 +0000
commit9c3054dae3578e4cee57aa6cd27cbef6425df320 (patch)
tree638f385159ac4ac5d419fa194f540304f09eadb0
parent0c53eb0351e3baaac93570ea57fec0f92836df32 (diff)
downloademacs-9c3054dae3578e4cee57aa6cd27cbef6425df320.tar.gz
emacs-9c3054dae3578e4cee57aa6cd27cbef6425df320.zip
(format-insert-annotations, format-annotate-location): Doc fixes.
(format-subtract-regions): Make arguments match their use in docstring.
-rw-r--r--lisp/format.el12
1 files changed, 7 insertions, 5 deletions
diff --git a/lisp/format.el b/lisp/format.el
index 525588eeca4..f3a5ae2d581 100644
--- a/lisp/format.el
+++ b/lisp/format.el
@@ -750,13 +750,15 @@ to write these unknown annotations back into the file."
750 (message "Unknown annotations: %s" unknown-ans)))))) 750 (message "Unknown annotations: %s" unknown-ans))))))
751 751
752(defun format-subtract-regions (minu subtra) 752(defun format-subtract-regions (minu subtra)
753 "Remove from the regions in MINUend the regions in SUBTRAhend. 753 "Remove from the regions in MINUEND the regions in SUBTRAHEND.
754A region is a dotted pair (FROM . TO). Both parameters are lists of 754A region is a dotted pair (FROM . TO). Both parameters are lists of
755regions. Each list must contain nonoverlapping, noncontiguous 755regions. Each list must contain nonoverlapping, noncontiguous
756regions, in descending order. The result is also nonoverlapping, 756regions, in descending order. The result is also nonoverlapping,
757noncontiguous, and in descending order. The first element of MINUEND 757noncontiguous, and in descending order. The first element of MINUEND
758can have a cdr of nil, indicating that the end of that region is not 758can have a cdr of nil, indicating that the end of that region is not
759yet known." 759yet known.
760
761\(fn MINUEND SUBTRAHEND)"
760 (let* ((minuend (copy-alist minu)) 762 (let* ((minuend (copy-alist minu))
761 (subtrahend (copy-alist subtra)) 763 (subtrahend (copy-alist subtra))
762 (m (car minuend)) 764 (m (car minuend))
@@ -809,8 +811,8 @@ in the region, it is treated as though it were DEFAULT."
809Inserts each element of the given LIST of buffer annotations at its 811Inserts each element of the given LIST of buffer annotations at its
810appropriate place. Use second arg OFFSET if the annotations' locations are 812appropriate place. Use second arg OFFSET if the annotations' locations are
811not relative to the beginning of the buffer: annotations will be inserted 813not relative to the beginning of the buffer: annotations will be inserted
812at their location-OFFSET+1 \(ie, the offset is treated as the character number 814at their location-OFFSET+1 \(ie, the offset is treated as the position of
813of the first character in the buffer)." 815the first character in the buffer)."
814 (if (not offset) 816 (if (not offset)
815 (setq offset 0) 817 (setq offset 0)
816 (setq offset (1- offset))) 818 (setq offset (1- offset)))
@@ -920,7 +922,7 @@ The same TRANSLATIONS structure can be used in reverse for reading files."
920 922
921(defun format-annotate-location (loc all ignore translations) 923(defun format-annotate-location (loc all ignore translations)
922 "Return annotation(s) needed at location LOC. 924 "Return annotation(s) needed at location LOC.
923This includes any properties that change between LOC-1 and LOC. 925This includes any properties that change between LOC - 1 and LOC.
924If ALL is true, don't look at previous location, but generate annotations for 926If ALL is true, don't look at previous location, but generate annotations for
925all non-nil properties. 927all non-nil properties.
926Third argument IGNORE is a list of text-properties not to consider. 928Third argument IGNORE is a list of text-properties not to consider.