all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: npostavs@users.sourceforge.net
Cc: 25357@debbugs.gnu.org
Subject: bug#25357: 25.1; Doc for `cursor-sensor-mode' (and modes generally)
Date: Wed, 4 Jan 2017 20:29:08 -0800 (PST)	[thread overview]
Message-ID: <678f8299-e6e8-4b08-a412-bf367194f6d7@default> (raw)
In-Reply-To: <878tqq5fw2.fsf@users.sourceforge.net>

> > I even think it would help to emphasize that "one" - not zero.
> > IOW, you cannot turn off a major mode without turning on another one.
> 
> Sure, here's a patch to the manuals to clarify that.

Thanks.  Some minor comments.  If they help, fine; if not, ignore.
One not-so-minor comment, flagged by ** (in two places).

---

The comma here should be a semicolon (or use two sentences);
otherwise it is a comma splice:

  ``turn off'' a major mode, instead you must switch
                           ;

> I don't think explaining about the relationship between M-x and
> Lisp functions again is needed though.

** How so, "again"?  Here we are telling someone how to turn it
on interactively.  I think we should also tell them how to do it
using Lisp.

Or at least cross-reference some Elisp manual reference doc that
tells you that you "turn on" a major mode by calling the function
with no arguments.  Examples where you add a major-mode function
as a normal hook imply that (no args), but it would be good to
spell it out once.

Here, I would drop the apostrophe - not needed:

  definitions that customize Emacs' behavior

Here, I would say for a particular kind of editing or
interaction:

  used for editing a particular kind of text

(Not all modes are for editing, in the usually understood sense.)

Here, I would append "at a time".

  Each buffer has exactly one @dfn{major mode}.

Otherwise it sounds like the mode-buffer association is fixed.

For this:

  Major modes specialize Emacs for editing particular kinds of text.

see above.  We should not give the impression that a major mode
is only for editing.  `Info-mode' is not an editing mode (in the
usual sense), for example.  (Yes, I know that this particular text
was already there.)

This is OK, and I see that you put it in quotes (which is good):

  the only way to ``turn off'' a major mode is to switch to
  a different one.

But it is different from what you said in the Emacs manual, where
(I  thought that) you specifically avoided any mention of turning
a major mode on or off, and instead spoke about putting the buffer
into the given mode.

IOW, either we say that you CANNOT turn off (with quotes) a major
mode, and INSTEAD of turning it off you switch the buffer to a
different mode, or we say that THE WAY TO turn it off (with quotes)
is to switch to a different mode.  Those are different statements.
Either is OK by me, but it might be better not to use both.

** Again, though, I think we should say explicitly somewhere
(in the Elisp manual, as reference, and either linked to that
or repeated in the Emacs manual) that you put a buffer into a
major mode by invoking the mode function with no args.

I repeat: feel free to ignore any of the above, and please make
the changes you feel are best at this point.  Thx.





  reply	other threads:[~2017-01-05  4:29 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <<de93b37f-921f-4a6e-9f29-a357cf6b1c55@default>
     [not found] ` <<83o9zmemfo.fsf@gnu.org>
2017-01-04 18:07   ` bug#25357: 25.1; Doc for `cursor-sensor-mode' (and modes generally) Drew Adams
2017-01-04 18:56     ` Noam Postavsky
2017-01-04 19:06       ` Drew Adams
2017-01-04 19:27         ` Noam Postavsky
2017-01-04 21:02           ` Drew Adams
2017-01-05  3:45             ` npostavs
2017-01-05  4:29               ` Drew Adams [this message]
2017-01-06  3:58                 ` npostavs
2017-01-06  5:50                   ` Drew Adams
2017-01-06  7:57                     ` Eli Zaretskii
2017-01-08 17:15                   ` npostavs
2017-01-05 15:28               ` Eli Zaretskii
     [not found]   ` <<83mvf6em4p.fsf@gnu.org>
2017-01-04 18:08     ` Drew Adams
     [not found] <<9ad8b225-73da-4533-a676-b0f8e84e54ca@default>
     [not found] ` <<CAM-tV--ymvk7wQ9VyBCSse1fQQqVxoH9htTnZdHmZGZYeH543A@mail.gmail.com>
     [not found]   ` <<a9c8bee8-1564-4bd3-81c4-2753a14e53a9@default>
     [not found]     ` <<CAM-tV-_+WRvc6+jZpHgywOx0XdgPUxdqyGc40cJ+R2s8ZyL=TQ@mail.gmail.com>
     [not found]       ` <<a2675f96-d075-408b-81e2-3a3045148b76@default>
     [not found]         ` <<878tqq5fw2.fsf@users.sourceforge.net>
     [not found]           ` <<678f8299-e6e8-4b08-a412-bf367194f6d7@default>
     [not found]             ` <<87a8b44z72.fsf@users.sourceforge.net>
     [not found]               ` <<bcd0da83-e266-4c27-a678-d429f07d7d58@default>
     [not found]                 ` <<83lguod3i4.fsf@gnu.org>
2017-01-06 14:50                   ` Drew Adams
2017-01-04 17:44 Drew Adams
2017-01-04 17:59 ` Eli Zaretskii
2017-01-04 18:05   ` Eli Zaretskii

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=678f8299-e6e8-4b08-a412-bf367194f6d7@default \
    --to=drew.adams@oracle.com \
    --cc=25357@debbugs.gnu.org \
    --cc=npostavs@users.sourceforge.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

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

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.