emacs-devel
[Top][All Lists]
Advanced

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

Re: Documentation not clear for the Lisp function set-variable


From: Yoni Rabkin
Subject: Re: Documentation not clear for the Lisp function set-variable
Date: Mon, 20 Jun 2005 11:21:06 +0300

On 6/20/05, Richard Stallman <address@hidden> wrote:
> How about this doc string?
> 
> (defun set-variable (var val &optional make-local)
>   "Set VARIABLE to VALUE.  VALUE is a Lisp object.
> VARIABLE should be a user option variable name, a Lisp variable
> meant to be customized by users.  You should enter VALUE in Lisp syntax,
> so if you want VALUE to be a string, you must surround it with doublequotes.
> VALUE is used literally, not evaluated.

[Snip]

I think that the above is a good doc string. The doc string states
clearly what VARIABLE is supposed to be.

-- 
"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]