ttn pushed a commit to branch master
in repository elpa.
commit c74783e3f9d4a5ab90ba94e7a0013ae43ccd39e8
Author: Thien-Thi Nguyen <t...@gnu.org>
Date: Fri Jun 13 14:34:43 2014 +0200
[xpm] Clarify function descriptions.
* packages/xpm/xpm.el (xpm-grok)
(xpm-generate-buffer, xpm-put-points): ...here.
* packages/xpm/xpm-m2z.el (xpm-m2z-ellipse): ...here.
---
packages/xpm/NEWS | 3 +++
packages/xpm/xpm-m2z.el | 4 ++--
packages/xpm/xpm.el | 13 +++++++------
3 files changed, 12 insertions(+), 8 deletions(-)
diff --git a/packages/xpm/NEWS b/packages/xpm/NEWS
index 6353aa2..264525a 100644
--- a/packages/xpm/NEWS
+++ b/packages/xpm/NEWS
@@ -2,6 +2,9 @@ NEWS for xpm.el (et al)
See the end for copying conditions.
+- 1.0.3 | NOT YET RELEASED
+ - improved docstrings
+
- 1.0.2 | 2014-05-30
- new homepage: http://www.gnuvola.org/software/xpm/
diff --git a/packages/xpm/xpm-m2z.el b/packages/xpm/xpm-m2z.el
index d8a5e9c..25d56fa 100644
--- a/packages/xpm/xpm-m2z.el
+++ b/packages/xpm/xpm-m2z.el
@@ -52,8 +52,8 @@ RX and RY, respectively. For example:
X -3 6 10
Y 0 7 8
-The span is always an even number. As a special case,
-if RX or RY is less than 1, the value is nil."
+The span is always an even number. As a special case, if the
+absolute value of RX or RY is less than 1, the value is nil."
(cl-assert (and (not (integerp cx))
(not (integerp cy)))
nil "Integer component in center coordinate: (%S,%S)"
diff --git a/packages/xpm/xpm.el b/packages/xpm/xpm.el
index 9579da3..256415e 100644
--- a/packages/xpm/xpm.el
+++ b/packages/xpm/xpm.el
@@ -92,8 +92,8 @@ shape to `xpm-raster', then you can ignore this variable.")
When called as a command, display in the echo area a
summary of image dimensions, cpp and palette.
Set buffer-local variable `xpm--gg' and return its value.
-Normally, preparation includes making certain parts of
-the buffer intangible. Optional arg SIMPLE inhibits that."
+Normally, preparation includes making certain parts of the
+buffer intangible. Optional arg SIMPLE non-nil inhibits that."
(interactive)
(unless (or
;; easy
@@ -188,14 +188,15 @@ a character or string of length CPP, and COLOR is a
string.
If COLOR includes a space, it is included directly,
otherwise it is automatically prefixed with \"c \".
-For example, to produce fragment:
+For example, to produce palette fragment:
\"X c blue\",
\"Y s border c green\",
you can specify PALETTE as:
- ((?X . \"blue\") (?Y . \"s border c green\"))
+ ((?X . \"blue\")
+ (?Y . \"s border c green\"))
This example presumes CPP is 1."
(let ((buf (generate-new-buffer name)))
@@ -230,8 +231,8 @@ This example presumes CPP is 1."
If both X and Y are vectors of length N, then place N points
using the pairwise vector elements. If one of X or Y is a vector
-of length N, then pair its elements with the other integer component
-and place N points.
+of length N and the other component is an integer, then pair the
+vector elements with the integer component and place N points.
If one of X or Y is a pair (LOW . HIGH), take it to be equivalent
to specfiying a vector [LOW ... HIGH]. For example, (3 . 8) is
