diff options
| author | Juanma Barranquero | 2004-06-07 20:48:10 +0000 |
|---|---|---|
| committer | Juanma Barranquero | 2004-06-07 20:48:10 +0000 |
| commit | 9c3054dae3578e4cee57aa6cd27cbef6425df320 (patch) | |
| tree | 638f385159ac4ac5d419fa194f540304f09eadb0 | |
| parent | 0c53eb0351e3baaac93570ea57fec0f92836df32 (diff) | |
| download | emacs-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.el | 12 |
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. |
| 754 | A region is a dotted pair (FROM . TO). Both parameters are lists of | 754 | A region is a dotted pair (FROM . TO). Both parameters are lists of |
| 755 | regions. Each list must contain nonoverlapping, noncontiguous | 755 | regions. Each list must contain nonoverlapping, noncontiguous |
| 756 | regions, in descending order. The result is also nonoverlapping, | 756 | regions, in descending order. The result is also nonoverlapping, |
| 757 | noncontiguous, and in descending order. The first element of MINUEND | 757 | noncontiguous, and in descending order. The first element of MINUEND |
| 758 | can have a cdr of nil, indicating that the end of that region is not | 758 | can have a cdr of nil, indicating that the end of that region is not |
| 759 | yet known." | 759 | yet 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." | |||
| 809 | Inserts each element of the given LIST of buffer annotations at its | 811 | Inserts each element of the given LIST of buffer annotations at its |
| 810 | appropriate place. Use second arg OFFSET if the annotations' locations are | 812 | appropriate place. Use second arg OFFSET if the annotations' locations are |
| 811 | not relative to the beginning of the buffer: annotations will be inserted | 813 | not relative to the beginning of the buffer: annotations will be inserted |
| 812 | at their location-OFFSET+1 \(ie, the offset is treated as the character number | 814 | at their location-OFFSET+1 \(ie, the offset is treated as the position of |
| 813 | of the first character in the buffer)." | 815 | the 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. |
| 923 | This includes any properties that change between LOC-1 and LOC. | 925 | This includes any properties that change between LOC - 1 and LOC. |
| 924 | If ALL is true, don't look at previous location, but generate annotations for | 926 | If ALL is true, don't look at previous location, but generate annotations for |
| 925 | all non-nil properties. | 927 | all non-nil properties. |
| 926 | Third argument IGNORE is a list of text-properties not to consider. | 928 | Third argument IGNORE is a list of text-properties not to consider. |