bug-gnu-emacs
[Top][All Lists]
Advanced

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

Re: Improving documentation for the info mode


From: Roland Winkler
Subject: Re: Improving documentation for the info mode
Date: 22 Sep 2001 16:07:42 +0200

"Eli Zaretskii" <address@hidden> writes:

> > From: Pr Kurlberg <address@hidden>
> > Date: Wed, 19 Sep 2001 16:37:06 +0200 (MET DST)
> > 
> > Please consider mentioning the 'i' (Info-index) command in the
> > 'Getting Started' section of the info node on info.  (Or perhaps
> > mention it in the 'Advanced Info' node.)  I just learned about the 'i'
> > command from reading a news group, and I find it very useful!

Another suggestion for improving the documentation for the
info mode:

At a first glance, the functions Info-menu (`m') and Info-goto-node
(`g') do very similar things. Unfortunately, I find the docstrings
not too helpful if one wants to figure out what is the difference
between these two functions. (Moreover the docstrings do not follow
the usual rule on how to refer to arguments of a function.)
Therefore, I suggest that the docstrings should be changed to
something like



Info-menu

Go to info node MENU-ITEM listed in the menu of the current info node.
Completion is allowed, and the menu item point is on is the default.

    Maybe I missed the point: Does the "abbreviated" in the present
    docstring refer to anything beyond what I usually expect from
    minibuffer completion?



Info-goto-node

Go to info node NODENAME in the current info file.
If NODENAME has a value (FILENAME)NAME it refers to node NAME in FILENAME.
Completion is allowed.


Roland



reply via email to

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