all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: John Shahid <jvshahid@gmail.com>
To: help-gnu-emacs@gnu.org
Subject: linum-mode docstring is unclear
Date: Sat, 24 Feb 2018 17:31:37 -0500	[thread overview]
Message-ID: <87muzyow8m.fsf@gmail.com> (raw)

Hey all,

I think the linum-mode docstring is unclear about when the mode is
turned on when called from Lisp. According to the docstring:

  "....  If called from Lisp, enable the mode if ARG is omitted or nil."

This isn't true. In fact, passing any value other than 0 will turn on
the mode. Furthermore, the docstring doesn't mention that passing
'toggle will toggle the state of the mode. WDYT, is that something that
can be/need clarification ?

I was thinking about borrowing the following from define-minor-mode:

  "When called from Lisp, the mode command toggles the mode if the
  argument is ‘toggle’, disables the mode if the argument is a
  non-positive integer, and enables the mode otherwise (including
  if the argument is omitted or nil or a positive integer)."

- js



             reply	other threads:[~2018-02-24 22:31 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-02-24 22:31 John Shahid [this message]
     [not found] <mailman.9701.1519511942.27995.help-gnu-emacs@gnu.org>
2018-02-24 22:50 ` linum-mode docstring is unclear Emanuel Berg
2018-02-25 20:29   ` John Shahid
     [not found]   ` <mailman.9721.1519590553.27995.help-gnu-emacs@gnu.org>
2018-02-25 20:41     ` Emanuel Berg

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=87muzyow8m.fsf@gmail.com \
    --to=jvshahid@gmail.com \
    --cc=help-gnu-emacs@gnu.org \
    /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.