unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Phil Sainty <psainty@orcon.net.nz>
To: dalanicolai@gmail.com
Cc: 49843@debbugs.gnu.org
Subject: bug#49843: 28.0.50; Error in docstring after using define-globalized-minor-mode
Date: Tue, 03 Aug 2021 20:37:50 +1200	[thread overview]
Message-ID: <70a6133fb48569d5bcc1a1bf191ce582@webmail.orcon.net.nz> (raw)
In-Reply-To: <b01de742893cadc324c5b4a71f454a24ef0ea877.camel@gmail.com>

On 2021-08-03 16:51, dalanicolai@gmail.com wrote:
> It looks like the docstring could just copy the explanation about
> behavior when calling from lisp from the `define-minor-mode'
> docstring.

I would use the more succinct explanation that `define-minor-mode'
generates (by default) for the docstring of the mode being defined.
E.g.:

"If called interactively, enable Eldoc mode if ARG is positive, and
disable it if ARG is zero or negative.  If called from Lisp, also
enable the mode if ARG is omitted or nil, and toggle it if ARG is
`toggle'; disable the mode otherwise."

This comes from the format variable `easy-mmode--arg-docstring'.


> (I am not sure if the `define-globalized-minor-mode' macro
> adds any logic for the behavior for (de)activating the global
> mode.

`define-globalized-minor-mode' uses `define-minor-mode' to define
the global mode, so there's no unusual behaviour.


> I think it only adds logic for the behavior i.c.w. its non-global
> mode, for which the explanation is not clear to me also b.t.w., but
> I am still trying to track down how that behaves exactly).

Which aspects are you unsure of?







  reply	other threads:[~2021-08-03  8:37 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-08-03  4:51 bug#49843: 28.0.50; Error in docstring after using define-globalized-minor-mode dalanicolai
2021-08-03  8:37 ` Phil Sainty [this message]
2021-08-03  9:18   ` Phil Sainty
2021-08-04  7:38     ` Lars Ingebrigtsen

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=70a6133fb48569d5bcc1a1bf191ce582@webmail.orcon.net.nz \
    --to=psainty@orcon.net.nz \
    --cc=49843@debbugs.gnu.org \
    --cc=dalanicolai@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 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).