From: Stefan Kangas <stefankangas@gmail.com>
Date: Thu, 18 Aug 2022 15:36:54 +0000 (+0200)
Subject: * lisp/image-mode.el: Improve commentary.
X-Git-Tag: emacs-28.2~44
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=254ba1d3e5;p=emacs.git

* lisp/image-mode.el: Improve commentary.
---

diff --git a/lisp/image-mode.el b/lisp/image-mode.el
index 1eb7cd58c3d..41a87a1a3f2 100644
--- a/lisp/image-mode.el
+++ b/lisp/image-mode.el
@@ -23,10 +23,14 @@
 
 ;;; Commentary:
 
-;; Defines a major mode for visiting image files
-;; that allows conversion between viewing the text of the file,
-;; hex of the file and viewing the file as an image.  Viewing the image
-;; works by putting a `display' text-property on the
+;; Defines `image-mode', a major mode for visiting image files.  Displaying
+;; images only works only if Emacs was built with support for
+;; displaying such images.  See Info node `(emacs) Image Mode' for
+;; more information.
+;;
+;; There is support for switching between viewing the text of the
+;; file, the hex of the file and viewing the file as an image.
+;; Viewing the image works by putting a `display' text-property on the
 ;; image data, with the image-data still present underneath; if the
 ;; resulting buffer file is saved to another name it will correctly save
 ;; the image data to the new file.