all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: Rusi <rustompmody@gmail.com>, help-gnu-emacs@gnu.org
Subject: RE: Disable menu bar mode
Date: Mon, 18 Dec 2017 18:37:43 -0800 (PST)	[thread overview]
Message-ID: <adc9b6dd-5b01-4b4a-89d3-de6bb4766062@default> (raw)
In-Reply-To: <6eb917e5-a6a3-46b2-b6c5-7b2488647935@googlegroups.com>

> IOW the complaint is with the confusing and incomplete
> documentation: «nil = true (turn on)?? So what is false then?»

This question comes up every so often.  It's a natural
one, in part because the doc strings for particular
minor modes sometimes suck, er, are less than perfect.

Doc strings of regular minor-mode commands (e.g., modes
defined with `define-minor-mode') should describe the
behavior, which is essentially the same for all such
modes.  And the doc strings should say clearly that the
command is, in fact, a minor-mode command.

Whether this gets done manually or partly automatically
(e.g. by `define-minor-mode'), it needs to be done.

The doc of macro `define-minor-mode', itself, is quite
good.  Unfortunately, an "end user" of a minor-mode
command is not necessarily going to consult the doc
for the macro that created the command ;-).

The doc string for the command itself needs to have
the info about it. This should be a no-brainer, I
think.  But the fact is that there is a fair amount
to say, and for whatever reasons, sometimes it is
omitted.

There have been a bunch of bugs filed about this
general problem.  Sometimes things do get improved.
Here are a couple such bug reports:

https://debbugs.gnu.org/cgi/bugreport.cgi?bug=25428
https://debbugs.gnu.org/cgi/bugreport.cgi?bug=29497
https://debbugs.gnu.org/cgi/bugreport.cgi?bug=20462



  parent reply	other threads:[~2017-12-19  2:37 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-12-14  1:55 Disable menu bar mode Rusi
2017-12-14  2:30 ` Emanuel Berg
2017-12-14  2:38 ` Emanuel Berg
2017-12-14  2:49   ` Kaushal Modi
     [not found]   ` <mailman.5687.1513219781.27995.help-gnu-emacs@gnu.org>
2017-12-14  3:11     ` Emanuel Berg
2017-12-14  5:13       ` Kaushal Modi
     [not found]       ` <mailman.5689.1513228434.27995.help-gnu-emacs@gnu.org>
2017-12-14  5:42         ` Emanuel Berg
2017-12-14 14:37           ` Stefan Monnier
2017-12-18 21:39 ` B. T. Raven
2017-12-19  1:45   ` Rusi
2017-12-19  2:37     ` Emanuel Berg
2017-12-19  2:37     ` Drew Adams [this message]
     [not found]     ` <mailman.5961.1513651377.27995.help-gnu-emacs@gnu.org>
2017-12-19 13:52       ` Rusi

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=adc9b6dd-5b01-4b4a-89d3-de6bb4766062@default \
    --to=drew.adams@oracle.com \
    --cc=help-gnu-emacs@gnu.org \
    --cc=rustompmody@gmail.com \
    /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.