branch: externals/auto-overlays
commit 033900e499705f4520647154ceb4729852b396a4
Author: Paul Eggert <[email protected]>
Commit: Stefan Monnier <[email protected]>
Fix some quoting problems in doc strings
Most of these are minor issues involving, e.g., quoting `like this'
instead of 'like this'. A few involve escaping ` and ' with a
preceding \= when the characters should not be turned into curved single
quotes.
---
auto-overlays.el | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
diff --git a/auto-overlays.el b/auto-overlays.el
index d83c591..bfc5e79 100644
--- a/auto-overlays.el
+++ b/auto-overlays.el
@@ -72,7 +72,7 @@ Comparison is done with 'eq."
(defun auto-o-position (item list)
"Find the first occurrence of ITEM in LIST.
Return the index of the matching item, or nil of not found.
-Comparison is done with 'equal."
+Comparison is done with `equal'."
(let (el (i 0))
(catch 'found
(while (setq el (nth i list))
@@ -822,7 +822,7 @@ DEFINITION should be a list of the form:
(CLASS @optional :id DEFINITION-ID @rest REGEXP1 REGEXP2 ... )
CLASS is a symbol specifying the auto-overlay class. The standard
-classes are 'word, 'line, 'self, 'flat and 'nested. The :id
+classes are `word', `line', `self', `flat' and `nested'. The :id
property is optional. It should be a symbol that uniquely
identifies the DEFINITION within SET-ID (see
`auto-overlay-unload-definition').
@@ -841,8 +841,8 @@ form (NAME . VALUE) where NAME is an overlay property name
(a
symbol) and VALUE is its value.
The EDGE and ID properties are optional. EDGE should be one of
-the symbols 'start or 'end. If it is not specified, :edge is
-assumed to be 'start. ID should be a symbol that uniquely
+the symbols `start' or `end'. If it is not specified, :edge is
+assumed to be `start'. ID should be a symbol that uniquely
identifies REGEXP within DEFINITION (see
`auto-overlay-unload-regexp')."
@@ -921,8 +921,8 @@ form (NAME . VALUE) where NAME is an overlay property name
(a
symbol) and VALUE is its value.
The :edge and :id properties are optional. EDGE should be one of
-the symbols 'start or 'end. If it is not specified, :edge is
-assumed to be 'start. ID property is a symbol that can be used to
+the symbols `start' or `end'. If it is not specified, :edge is
+assumed to be `start'. ID property is a symbol that can be used to
uniquely identify REGEXP (see `auto-overlay-unload-regexp')."
(let ((defs (assq definition-id (auto-o-get-set set-id)))
@@ -1850,13 +1850,13 @@ If START or END are numbers or markers, move that edge
to the
buffer location specified by the number or marker and make it
unmatched. If START or END are non-nil but neither of the above,
make that edge unmatched. If START or END are null, don't change
-that edge. However, if END is null, and START is an 'end overlay,
+that edge. However, if END is null, and START is an `end' overlay,
match end of OVERLAY rather than start.
If NO-PARSE is non-nil, block re-parsing due to exclusive overlay
changes. If NO-PROPS is non-nil, block updating of overlay's
properties. If PROTECT-MATCH is non-nil, don't modify any match
-overlays associated with OVERLAY (i.e. don't modify their 'parent
+overlays associated with OVERLAY (i.e. don't modify their `parent'
properties)."
(let ((old-start (overlay-start overlay))
@@ -2012,7 +2012,7 @@ properties)."
"Delete OVERLAY from buffer.
If PROTECT-MATCH is non-nil, don't modify any match overlays
-associated with OVERLAY (i.e. leave their 'parent properties
+associated with OVERLAY (i.e. leave their `parent' properties
alone). If NO-PARSE is non-nil, block re-parsing due to exclusive
overlay changes."
