[Emacs-diffs] master fc6de41: special-mode doc string clarification

[Lars Ingebrigtsen]

branch: master
commit fc6de411a7afeeb197eef0a23b83a5ea9a14bbc6
Author: Hong Xu <address@hidden>
Commit: Lars Ingebrigtsen <address@hidden>

    special-mode doc string clarification
    
    * lisp/simple.el (special-mode): Make the doc string explain what
    special modes are for (bug#37787).
---
 lisp/simple.el | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/lisp/simple.el b/lisp/simple.el
index cd674c3..338f3e3 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.