unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Luc Teirlinck <teirllm@dms.auburn.edu>
Subject: `define-minor-mode' makes erroneous docstrings.
Date: Mon, 11 Apr 2005 21:45:32 -0500 (CDT)	[thread overview]
Message-ID: <200504120245.j3C2jWQ11924@raven.dms.auburn.edu> (raw)

The docstrings provided by `define-minor-mode' are wrong for many
minor-mode variables.  They _automatically_ say that setting the
variable directly has no effect.  I believe that this is wrong for the
majority of minor modes.

For global minor modes, setting the variable buffer locally is often
useful, like for column-number-mode.  For local minor modes, you can
enable them globally by setting the default-value of the variable.

As an example here is what you get from `C-h v column-number-mode'.
It is definitely wrong, you can set it directly and buffer locally.
It works.

  column-number-mode's value is t
  Local in buffer *info*; global value is nil

  Non-nil if Column-Number mode is enabled.
  See the command `column-number-mode' for a description of this minor-mode.
  Setting this variable directly does not take effect;
  use either M-x customize or the function `column-number-mode'.

  You can customize this variable.

  Defined in `simple'.

             reply	other threads:[~2005-04-12  2:45 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2005-04-12  2:45 Luc Teirlinck [this message]
2005-04-12  3:09 ` `define-minor-mode' makes erroneous docstrings Luc Teirlinck
2005-04-12  3:29   ` Luc Teirlinck
2005-04-12  3:57 ` Stefan Monnier
2005-04-12 17:04   ` Luc Teirlinck
2005-04-12 17:23 ` Richard Stallman
2005-04-13  2:33   ` Luc Teirlinck

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

  List information: https://www.gnu.org/software/emacs/

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

  git send-email \
    --in-reply-to=200504120245.j3C2jWQ11924@raven.dms.auburn.edu \
    --to=teirllm@dms.auburn.edu \
    /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 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).