emacs-devel
[Top][All Lists]
Advanced

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

Documentation string for the 'complete-symbol' function


From: Yoni Rabkin
Subject: Documentation string for the 'complete-symbol' function
Date: Wed, 29 Jun 2005 11:03:53 +0300

Hello, 

I'm using:
GNU Emacs 22.0.50.1 (i686-pc-linux-gnu, X toolkit, Xaw3d scroll bars)
of 2005-05-30

In the documentation string for the function 'complete-symbol' the
argument list contains the argument "arg" but "arg" is not mentioned
explicitly in the documentation string text.

The documentation string for the function 'complete-symbol' is as follows:
[START DOCSTRING]
"complete-symbol is an interactive compiled Lisp function in `bindings'.
(complete-symbol arg)

Perform tags completion on the text around point.
Completes to the set of names listed in the current tags table.
The string to complete is chosen in the same way as the default
for M-. (which see).

With a prefix argument, this command does completion within
the collection of symbols listed in the index of the manual for the
language you are using."
[END DOCSTRING]

It might be good to add a description of what the argument "arg" does
by changing the last paragraph to something such as:
"With a prefix argument or if ARG is non-nil, this command does
completion within
the collection of symbols listed in the index of the manual for the
language you are using."
-- 
"Cut your own wood and it will warm you twice"
        Regards, Yoni Rabkin Katzenell




reply via email to

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