From: Hong Xu <hong@topbug.net>
Date: Sat, 19 Oct 2019 08:43:37 +0000 (+0200)
Subject: special-mode doc string clarification
X-Git-Tag: emacs-27.0.90~993
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=fc6de411a7afeeb197eef0a23b83a5ea9a14bbc6;p=emacs.git

special-mode doc string clarification

* lisp/simple.el (special-mode): Make the doc string explain what
special modes are for (bug#37787).
---

diff --git a/lisp/simple.el b/lisp/simple.el
index cd674c36e7b..338f3e3fd89 100644
--- a/lisp/simple.el
+++ b/lisp/simple.el
@@ -474,7 +474,10 @@ Other major modes are defined by comparison with this one."
 
 (put 'special-mode 'mode-class 'special)
 (define-derived-mode special-mode nil "Special"
-  "Parent major mode from which special major modes should inherit."
+  "Parent major mode from which special major modes should inherit.
+
+A special major mode is intended to view specially formatted data
+rather than files.  These modes usually use read-only buffers."
   (setq buffer-read-only t))
 
 ;; Making and deleting lines.