unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
* bug#37787: [PATCH] Update `special-mode' docstring.
@ 2019-10-17  6:25 Hong Xu
  2019-10-17  6:29 ` Hong Xu
  2019-10-18  3:37 ` Lars Ingebrigtsen
  0 siblings, 2 replies; 5+ messages in thread
From: Hong Xu @ 2019-10-17  6:25 UTC (permalink / raw)
  To: 37787


* lisp/simple.el (special-mode): Add more explanation for
`special-mode'.
---
 lisp/simple.el | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/lisp/simple.el b/lisp/simple.el
index e44b877931b6..2548a176f0a9 100644
--- a/lisp/simple.el
+++ b/lisp/simple.el
@@ -474,7 +474,9 @@ special-mode-map
 
 (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.  It is read-only and usually lightweight."
   (setq buffer-read-only t))
 
 ;; Making and deleting lines.
-- 
2.20.1







^ permalink raw reply related	[flat|nested] 5+ messages in thread

* bug#37787: [PATCH] Update `special-mode' docstring.
  2019-10-17  6:25 bug#37787: [PATCH] Update `special-mode' docstring Hong Xu
@ 2019-10-17  6:29 ` Hong Xu
  2019-10-18  3:37 ` Lars Ingebrigtsen
  1 sibling, 0 replies; 5+ messages in thread
From: Hong Xu @ 2019-10-17  6:29 UTC (permalink / raw)
  To: 37787

On 10/16/19 11:25 PM, Hong Xu wrote:
> +rather than files.  It is read-only and usually lightweight."

Sorry for the update. This final sentence may be better:

     It sets the buffer read-only and is usually lightweight.







^ permalink raw reply	[flat|nested] 5+ messages in thread

* bug#37787: [PATCH] Update `special-mode' docstring.
  2019-10-17  6:25 bug#37787: [PATCH] Update `special-mode' docstring Hong Xu
  2019-10-17  6:29 ` Hong Xu
@ 2019-10-18  3:37 ` Lars Ingebrigtsen
  2019-10-18 17:53   ` Hong Xu
  1 sibling, 1 reply; 5+ messages in thread
From: Lars Ingebrigtsen @ 2019-10-18  3:37 UTC (permalink / raw)
  To: Hong Xu; +Cc: 37787

Hong Xu <hong@topbug.net> writes:

> * lisp/simple.el (special-mode): Add more explanation for
> `special-mode'.

[...]

> +A special major mode is intended to view specially formatted data
> +rather than files.  It is read-only and usually lightweight."

What do you mean by "lightweight"?  My guess is that, on average,
special modes have more code than non-special modes.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no





^ permalink raw reply	[flat|nested] 5+ messages in thread

* bug#37787: [PATCH] Update `special-mode' docstring.
  2019-10-18  3:37 ` Lars Ingebrigtsen
@ 2019-10-18 17:53   ` Hong Xu
  2019-10-19  8:43     ` Lars Ingebrigtsen
  0 siblings, 1 reply; 5+ messages in thread
From: Hong Xu @ 2019-10-18 17:53 UTC (permalink / raw)
  To: Lars Ingebrigtsen; +Cc: 37787

On 10/17/19 8:37 PM, Lars Ingebrigtsen wrote:
> Hong Xu <hong@topbug.net> writes:
> 
>> * lisp/simple.el (special-mode): Add more explanation for
>> `special-mode'.
> 
> [...]
> 
>> +A special major mode is intended to view specially formatted data
>> +rather than files.  It is read-only and usually lightweight."
> 
> What do you mean by "lightweight"?  My guess is that, on average,
> special modes have more code than non-special modes.
> 

Looks like I got that wrong. We can remove that part.






^ permalink raw reply	[flat|nested] 5+ messages in thread

* bug#37787: [PATCH] Update `special-mode' docstring.
  2019-10-18 17:53   ` Hong Xu
@ 2019-10-19  8:43     ` Lars Ingebrigtsen
  0 siblings, 0 replies; 5+ messages in thread
From: Lars Ingebrigtsen @ 2019-10-19  8:43 UTC (permalink / raw)
  To: Hong Xu; +Cc: 37787

Hong Xu <hong@topbug.net> writes:

>>> +A special major mode is intended to view specially formatted data
>>> +rather than files.  It is read-only and usually lightweight."
>> What do you mean by "lightweight"?  My guess is that, on average,
>> special modes have more code than non-special modes.
>> 
>
> Looks like I got that wrong. We can remove that part.

I've now done so and applied your patch.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no





^ permalink raw reply	[flat|nested] 5+ messages in thread

end of thread, other threads:[~2019-10-19  8:43 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-10-17  6:25 bug#37787: [PATCH] Update `special-mode' docstring Hong Xu
2019-10-17  6:29 ` Hong Xu
2019-10-18  3:37 ` Lars Ingebrigtsen
2019-10-18 17:53   ` Hong Xu
2019-10-19  8:43     ` Lars Ingebrigtsen

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).