[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
make-overlay text incorrect in Elisp manual and doc string
From: |
Drew Adams |
Subject: |
make-overlay text incorrect in Elisp manual and doc string |
Date: |
Sat, 16 Jul 2005 14:11:12 -0700 |
Elisp Info node Managing Overlays says this:
-- Function: make-overlay start end &optional buffer front-advance
rear-advance
This function creates and returns an overlay that belongs to
BUFFER and ranges from START to END. Both START and END must
specify buffer positions; they may be integers or markers. If
BUFFER is omitted, the overlay is created in the current buffer.
The arguments FRONT-ADVANCE and REAR-ADVANCE specify the insertion
type for the start of the overlay and for the end of the overlay,
respectively. *Note Marker Insertion Types::. If FRONT-ADVANCE
is non-`nil', text inserted at the beginning of the overlay is
excluded from the overlay. If READ-ADVANCE is non-`nil', text
inserted at the beginning of the overlay is included in the
overlay.
The last sentence is incorrect (and has the typo READ instead of
REAR), or at least it makes no sense in connection with the sentence
before it. The doc string presumably has the correct meaning of
REAR-ADVANCE:
The fourth arg front-advance, if non-nil, makes the
front delimiter advance when text is inserted there.
The fifth arg rear-advance, if non-nil, makes the
rear delimiter advance when text is inserted there.
However, the doc string is not clear - just what is meant by "makes
the ... delimiter advance" and what is meant by "is inserted there"
(where?).
Both doc string and Info text should say explicitly whether text
inserted just before or just after the overlay is included in the
overlay.
In GNU Emacs 22.0.50.1 (i386-mingw-nt5.1.2600)
of 2005-06-26 on NONIQPC
X server distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc
(3.3) --cflags -I../../jpeg-6b-3/include -I../../libpng-1.2.8/include -I../.
./tiff-3.6.1-2/include -I../../xpm-nox-4.2.0/include -I../../zlib-1.2.2/incl
ude'
- make-overlay text incorrect in Elisp manual and doc string,
Drew Adams <=