summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2022-09-14 21:37:50 +0300
committerEli Zaretskii <eliz@gnu.org>2022-09-14 21:37:50 +0300
commit7e6923017163561d1b8cedf15aac42e01e493aee (patch)
tree6f7a4700f6bd8332032e47f5eca249572a2378c0
parentb525f201ba9f4f8862059a49947874a2bfa0d2f1 (diff)
downloademacs-7e6923017163561d1b8cedf15aac42e01e493aee.tar.gz
emacs-7e6923017163561d1b8cedf15aac42e01e493aee.tar.bz2
emacs-7e6923017163561d1b8cedf15aac42e01e493aee.zip
; * lisp/image/image-crop.el (image-elide, image-crop): Doc fixes.
-rw-r--r--lisp/image/image-crop.el21
1 files changed, 10 insertions, 11 deletions
diff --git a/lisp/image/image-crop.el b/lisp/image/image-crop.el
index 64db226d50e..7716efcd543 100644
--- a/lisp/image/image-crop.el
+++ b/lisp/image/image-crop.el
@@ -100,12 +100,11 @@ image data.")
;;;###autoload
(defun image-elide (color &optional square)
- "Elide a square from the image under point.
-If SQUARE (interactively, the prefix), elide a square instead of a
-rectangle from the image.
+ "Elide a rectangle from the image under point, filling it with COLOR.
+If SQUARE is non-nil (interactively, prefix arg), elide a square
+instead of a rectangle from the image.
-Interatively, the user will be prompted for the color to use, and
-defaults to black."
+Interactively, prompt for COLOR to use, defaulting to black."
(interactive (list (read-color "Use color: ")
current-prefix-arg))
(image-crop square (if (string-empty-p color)
@@ -114,14 +113,14 @@ defaults to black."
;;;###autoload
(defun image-crop (&optional square elide)
"Crop the image under point.
-If SQUARE (interactively, the prefix), crop a square instead of a
-rectangle from the image.
+If SQUARE is non-nil (interactively, prefix arg), crop a square
+instead of a rectangle from the image.
-If ELIDE, remove a rectangle from the image instead of cropping
-the image. In that case ELIDE, should be the name of a color to
-use.
+If ELIDE is non-nil, remove a rectangle/square from the image
+instead of cropping the image. In that case ELIDE should be
+the name of a color to fill the rectangle.
-After cropping an image, it can be saved by `M-x image-save' or
+After cropping an image, you can save it by `M-x image-save' or
\\<image-map>\\[image-save] when point is over the image."
(interactive "P")
(unless (image-type-available-p 'svg)