composite.el (compose-region, reference-point-alist): Fix typos in the doc
authorEli Zaretskii <eliz@gnu.org>
Sat, 1 May 2010 18:50:20 +0000 (21:50 +0300)
committerEli Zaretskii <eliz@gnu.org>
Sat, 1 May 2010 18:50:20 +0000 (21:50 +0300)
 strings.

lisp/ChangeLog
lisp/composite.el

index 75c16683dca52a0650ad093c81db9ec0d1522648..610b3f5046b20f627c59a9b96df761fddf1152e1 100644 (file)
@@ -1,3 +1,8 @@
+2010-05-01  Eli Zaretskii  <eliz@gnu.org>
+
+       * composite.el (compose-region, reference-point-alist): Fix typos
+       in the doc strings.
+
 2010-04-28  Alexander Klimov <alserkli@inbox.ru> (tiny change)
 
        * calc/calc-graph.el (calc-graph-plot): Use the proper form for
index e3753f3bfd0366f5cd56befc91c9f24cb10ad2cc..5b01718fc715402b8e88c961c0ecce01051016bd 100644 (file)
@@ -44,7 +44,7 @@
 A glyph reference point symbol is to be used to specify a composition
 rule in COMPONENTS argument to such functions as `compose-region'.
 
-Meanings of glyph reference point codes are as follows:
+The meaning of glyph reference point codes is as follows:
 
     0----1----2 <---- ascent   0:tl or top-left
     |         |                        1:tc or top-center
@@ -212,7 +212,7 @@ If it is a string, the elements are alternate characters.  In
 this case, TAB element has a special meaning.  If the first
 characer is TAB, the glyphs are displayed with left padding space
 so that no pixel overlaps with the previous column.  If the last
-character is TAB, the glyphs are displayed with rigth padding
+character is TAB, the glyphs are displayed with right padding
 space so that no pixel overlaps with the following column.
 
 If it is a vector or list, it is a sequence of alternate characters and
@@ -222,7 +222,7 @@ elements with previously composed N glyphs.
 
 A composition rule is a cons of global and new glyph reference point
 symbols.  See the documentation of `reference-point-alist' for more
-detail.
+details.
 
 Optional 4th argument MODIFICATION-FUNC is a function to call to
 adjust the composition when it gets invalid because of a change of
@@ -299,16 +299,16 @@ A composition rule is a cons of glyph reference points of the form
     (compose-string-internal str 0 (length str) components)))
 
 (defun find-composition (pos &optional limit string detail-p)
-  "Return information about a composition at or nearest to buffer position POS.
+  "Return information about a composition at or near buffer position POS.
 
 If the character at POS has `composition' property, the value is a list
-of FROM, TO, and VALID-P.
+\(FROM TO VALID-P).
 
 FROM and TO specify the range of text that has the same `composition'
 property, VALID-P is t if this composition is valid, and nil if not.
 
 If there's no composition at POS, and the optional 2nd argument LIMIT
-is non-nil, search for a composition toward LIMIT.
+is non-nil, search for a composition toward the position given by LIMIT.
 
 If no composition is found, return nil.
 
@@ -316,8 +316,9 @@ Optional 3rd argument STRING, if non-nil, is a string to look for a
 composition in; nil means the current buffer.
 
 If a valid composition is found and the optional 4th argument DETAIL-P
-is non-nil, the return value is a list of FROM, TO, COMPONENTS,
-RELATIVE-P, MOD-FUNC, and WIDTH.
+is non-nil, the return value is a list of the form
+
+   (FROM TO COMPONENTS RELATIVE-P MOD-FUNC WIDTH)
 
 COMPONENTS is a vector of integers, the meaning depends on RELATIVE-P.
 
@@ -334,9 +335,9 @@ WIDTH is a number of columns the composition occupies on the screen.
 When Automatic Composition mode is on, this function also finds a
 chunk of text that is automatically composed.  If such a chunk is
 found closer to POS than the position that has `composition'
-property, the value is a list of FROM, TO, and a glyph gstring
-the specify how the chunk is composed.  See the function
-`composition-get-gstring' for the format of the glyph string."
+property, the value is a list of FROM, TO, and a glyph-string
+that specifies how the chunk is to be composed.  See the function
+`composition-get-gstring' for the format of the glyph-string."
   (let ((result (find-composition-internal pos limit string detail-p)))
     (if (and detail-p (> (length result) 3) (nth 2 result) (not (nth 3 result)))
        ;; This is a valid rule-base composition.