unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: 50146@debbugs.gnu.org
Subject: bug#50146: 26.3; Doc of `MODE-' things created by `define-globalized-minor-mode'
Date: Sat, 21 Aug 2021 15:46:38 +0000	[thread overview]
Message-ID: <SJ0PR10MB5488C69E2EACAF87FB561155F3C29@SJ0PR10MB5488.namprd10.prod.outlook.com> (raw)

A user can be puzzled by `C-h v' and `C-h f' completion showing the
names of variables and functions that get created by macro
`define-globalized-minor-mode'.  `C-h v' and `C-h f' are primary means
of discovery.

If a user chooses such a name from completion she's not helped, but
further pushed into puzzlement.  She'll see something like this:

  foo-mode-set-explicitly is a Lisp function in 'foobar.el'.

  (foo-mode-set-explicitly)

And clicking that file-name link won't help at all, but will add to the
confusion.

Can we not fix this somehow?

If nothing really reasonable can be found to fix this, maybe a kludge
improvement would be to at least add a doc string to such a created
thing, which says that the thing was created by
`define-globalized-minor-mode' and perhaps points to that macro.  And
perhaps that doc string could point to the corresponding mode command,
so users can consult its doc (which won't mention the thing created, but
at least might get users closer to what's going on).

In GNU Emacs 26.3 (build 1, x86_64-w64-mingw32)
 of 2019-08-29
Repository revision: 96dd0196c28bc36779584e47fffcca433c9309cd
Windowing system distributor `Microsoft Corp.', version 10.0.19042
Configured using:
 `configure --without-dbus --host=x86_64-w64-mingw32
 --without-compress-install 'CFLAGS=-O2 -static -g3''






             reply	other threads:[~2021-08-21 15:46 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-08-21 15:46 Drew Adams [this message]
2021-08-21 15:59 ` bug#50146: 26.3; Doc of `MODE-' things created by `define-globalized-minor-mode' Eli Zaretskii
2021-08-21 16:25   ` bug#50146: [External] : " Drew Adams
2021-08-21 16:46     ` Eli Zaretskii
2021-08-22 14:49       ` 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=SJ0PR10MB5488C69E2EACAF87FB561155F3C29@SJ0PR10MB5488.namprd10.prod.outlook.com \
    --to=drew.adams@oracle.com \
    --cc=50146@debbugs.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 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).