On 6/20/05, Richard Stallman <[EMAIL PROTECTED]> 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
_______________________________________________
Emacs-devel mailing list
Emacs-devel@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-devel
