special-mode doc string clarification

* lisp/simple.el (special-mode): Make the doc string explain what
special modes are for (bug#37787).
This commit is contained in:
Hong Xu 2019-10-19 10:43:37 +02:00 committed by Lars Ingebrigtsen
parent e4a4aa3057
commit fc6de411a7

View file

@ -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.