emacs-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

RE: 1) `C-h m' minor mode info is too noisy 2) other suggestions aboutmi


From: Drew Adams
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

    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 via email to

[Prev in Thread] Current Thread [Next in Thread]