[Top][All Lists]
[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
- Documentation not clear for the Lisp function set-variable, Yoni Rabkin, 2005/06/19
- Re: Documentation not clear for the Lisp function set-variable, Richard Stallman, 2005/06/19
- Re: Documentation not clear for the Lisp function set-variable,
Yoni Rabkin <=
- Re: Documentation not clear for the Lisp function set-variable, Juanma Barranquero, 2005/06/20
- Re: Documentation not clear for the Lisp function set-variable, Juri Linkov, 2005/06/26
- Re: Documentation not clear for the Lisp function set-variable, Juanma Barranquero, 2005/06/27
- Re: Documentation not clear for the Lisp function set-variable, Juanma Barranquero, 2005/06/27
- Re: Documentation not clear for the Lisp function set-variable, Luc Teirlinck, 2005/06/27
- Re: Documentation not clear for the Lisp function set-variable, Juanma Barranquero, 2005/06/27
- Re: Documentation not clear for the Lisp function set-variable, Luc Teirlinck, 2005/06/27
- Re: Documentation not clear for the Lisp function set-variable, Juanma Barranquero, 2005/06/27
- Re: Documentation not clear for the Lisp function set-variable, Richard M. Stallman, 2005/06/28