From: Yoni Rabkin <yonirabkin@gmail.com>
Subject: Re: Documentation not clear for the Lisp function set-variable
Date: Mon, 20 Jun 2005 11:21:06 +0300 [thread overview]
Message-ID: <b6d534df050620012144824a1b@mail.gmail.com> (raw)
In-Reply-To: <E1DkDIo-0004LD-FN@fencepost.gnu.org>
On 6/20/05, Richard Stallman <rms@gnu.org> 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
next prev parent reply other threads:[~2005-06-20 8:21 UTC|newest]
Thread overview: 47+ messages / expand[flat|nested] mbox.gz Atom feed top
2005-06-19 11:14 Documentation not clear for the Lisp function set-variable Yoni Rabkin
2005-06-20 3:50 ` Richard Stallman
2005-06-20 8:21 ` Yoni Rabkin [this message]
2005-06-20 9:07 ` Juanma Barranquero
2005-06-21 2:00 ` Richard Stallman
2005-06-26 23:23 ` Juri Linkov
2005-06-27 13:04 ` Juanma Barranquero
2005-06-27 15:44 ` Juanma Barranquero
2005-06-27 16:09 ` Luc Teirlinck
2005-06-27 18:17 ` Juanma Barranquero
2005-06-27 18:45 ` Luc Teirlinck
2005-06-27 19:30 ` Juanma Barranquero
2005-06-28 18:47 ` Richard M. Stallman
2005-07-04 1:18 ` Luc Teirlinck
2005-07-04 16:48 ` Richard M. Stallman
2005-07-04 17:02 ` David Kastrup
2005-07-05 1:42 ` Luc Teirlinck
2005-07-05 16:12 ` Richard M. Stallman
2005-07-07 1:54 ` Luc Teirlinck
2005-07-07 21:30 ` Richard M. Stallman
2005-06-28 0:07 ` Juri Linkov
2005-06-28 8:32 ` Juanma Barranquero
2005-06-28 23:45 ` Juri Linkov
2005-06-29 9:14 ` Juanma Barranquero
2005-06-29 23:57 ` Juri Linkov
2005-06-30 8:16 ` Juanma Barranquero
2005-06-30 16:55 ` Luc Teirlinck
2005-06-30 19:34 ` Juanma Barranquero
2005-07-01 23:57 ` Juri Linkov
2005-07-02 4:11 ` Luc Teirlinck
2005-06-28 18:47 ` Richard M. Stallman
2005-06-29 2:32 ` Juanma Barranquero
2005-06-29 20:42 ` Richard M. Stallman
2005-06-27 18:39 ` Eli Zaretskii
2005-06-27 18:49 ` Luc Teirlinck
2005-06-27 21:38 ` Juanma Barranquero
2005-06-28 4:37 ` Eli Zaretskii
2005-06-28 8:33 ` Juanma Barranquero
2005-06-28 4:17 ` Richard M. Stallman
2005-06-28 9:17 ` Juanma Barranquero
2005-06-28 9:26 ` Juanma Barranquero
2005-06-28 16:09 ` Stefan Monnier
2005-06-28 16:19 ` Juanma Barranquero
2005-06-29 3:43 ` Stefan Monnier
2005-06-29 9:18 ` Juanma Barranquero
2005-06-29 3:59 ` Richard M. Stallman
2005-06-27 16:46 ` Richard M. Stallman
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=b6d534df050620012144824a1b@mail.gmail.com \
--to=yonirabkin@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).