[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Improving documentation for the info mode
From: |
Eli Zaretskii |
Subject: |
Re: Improving documentation for the info mode |
Date: |
Sat, 22 Sep 2001 18:08:57 +0300 |
> From: Roland Winkler <Roland.Winkler@physik.uni-erlangen.de>
> Newsgroups: gnu.emacs.bug
> Date: 22 Sep 2001 16:07:42 +0200
>
> 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
Thanks, I fixed the doc strings, albeit a bit differently.
> Maybe I missed the point: Does the "abbreviated" in the present
> docstring refer to anything beyond what I usually expect from
> minibuffer completion?
Yes, it refers to the fact that this function allows abbreviated menu
item names even in non-interactive invocation. By contrast,
completion only works when functions are invoked interactively.