unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: "Drew Adams" <drew.adams@oracle.com>
Subject: RE: 1) `C-h m' minor mode info is too noisy 2) other suggestions aboutminor-mode help
Date: Sat, 5 Aug 2006 21:59:38 -0700	[thread overview]
Message-ID: <EIENLHALHGIMHGDOLMIMGEFKCKAA.drew.adams@oracle.com> (raw)
In-Reply-To: <E1G9aUd-0005Gl-3l@fencepost.gnu.org>

    I implemented most of your suggestions, but rather than using columns,
    I just filled the paragraph.

Thx.

        1. If you click a minor-mode name in the list, you go to
        the minor-mode description, but clicking [back] then does
        not take you back to the link you clicked - it takes you
        to a previous *Help* screen. This seems like a bug.
        If [back] can't be made to DTRT, then each minor-mode
        description should have a [back] (or [top]) link.

    I pretty much agree, but I am not going to try to implement that.

It's an "inconvenience" bug that could perhaps be fixed after the release. I
didn't mean that this should be changed before the release.

        If there is nothing unconventional about the toggling, then
        the toggling info would be provided automatically by
        `define-minor-mode'. If there is something unconventional,
        then that info could be included in a second,
        optional doc-string arg. When that optional arg is present,
        `define-minor-mode' would not automatically add the
        (conventional) toggling info.

    It is a reasonable idea, but too big a change to be considered for now.

Yes, I didn't mean to suggest that this should be changed before the
release. If implemented, this new feature would let us clean up the `C-h m'
treatment of minor modes, by extracting only the mode descriptions, not the
command descriptions, for `C-h m'. It might also encourage better minor-mode
descriptions.

`C-h m' is an important means of communication, in many cases, of
information that is not available elsewhere (unless there is an info manual
for the mode). Some modes are well described; some others are not. Cleaning
up the minor-mode part of `C-h m' would be one general improvement that
could be made. Improving individual major-mode doc strings would be another
step in the right direction.

      reply	other threads:[~2006-08-06  4:59 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2006-08-05 21:37 1) `C-h m' minor mode info is too noisy 2) other suggestions about minor-mode help Drew Adams
2006-08-06  3:26 ` Eli Zaretskii
2006-08-06  4:44 ` Richard Stallman
2006-08-06  4:59   ` Drew Adams [this message]

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=EIENLHALHGIMHGDOLMIMGEFKCKAA.drew.adams@oracle.com \
    --to=drew.adams@oracle.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).