GNU bug report logs - #50146
26.3; Doc of `MODE-' things created by `define-globalized-minor-mode'

Previous Next

Full log

View this message in rfc822 format

From: Drew Adams <drew.adams <at> oracle.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: "50146 <at> debbugs.gnu.org" <50146 <at> debbugs.gnu.org>
Subject: bug#50146: [External] : Re: bug#50146: 26.3; Doc of `MODE-' things created by `define-globalized-minor-mode'
Date: Sat, 21 Aug 2021 16:25:59 +0000

> Please provide a specific example or two.  I tried looking at
> global-visual-line-mode, and didn't see anything like what you
> describe.

emacs -Q

(define-minor-mode foo-mode "..."
  :init-value nil :global t :group 'convenience)

(defun turn-on-foo-mode () "..." (foo-mode 1))

(define-globalized-minor-mode foo-global-mode
  foo-mode turn-on-foo-mode :group 'convenience)

C-h f foo TAB
___

You see this in *Completions*:

Click on a completion to select it.
In this buffer, type RET to select the completion near point.

Possible completions are:
foo-global-mode 	foo-global-mode-check-buffers
foo-global-mode-cmhh 	foo-global-mode-enable-in-buffers
foo-mode 	foo-mode-set-explicitly
footnote-mode
___

`foo-mode-set-explicitly' is created by the macro.
If you click that name in *Completions* you see this:
___

foo-mode-set-explicitly is a Lisp function.

(foo-mode-set-explicitly)

Not documented.
___

Same thing, if you use `C-h v foo TAB' and choose
`foo-mode-set-explicitly': the help for the var is
just as vacuous.

These automatically created things seems like noise,
for users.  If they're intended to be under the covers
then maybe they should be more under the covers.

If they're intended to be usable by, or understandable
to, users, then maybe they should have some doc that at
least tries to dispel some of the possible confusion.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.