From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Yoni Rabkin Newsgroups: gmane.emacs.devel Subject: Re: Documentation not clear for the Lisp function set-variable Date: Mon, 20 Jun 2005 11:21:06 +0300 Message-ID: References: Reply-To: Yoni Rabkin NNTP-Posting-Host: main.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: quoted-printable X-Trace: sea.gmane.org 1119256710 6074 80.91.229.2 (20 Jun 2005 08:38:30 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Mon, 20 Jun 2005 08:38:30 +0000 (UTC) Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Mon Jun 20 10:38:28 2005 Return-path: Original-Received: from lists.gnu.org ([199.232.76.165]) by ciao.gmane.org with esmtp (Exim 4.43) id 1DkHmu-000521-2Q for ged-emacs-devel@m.gmane.org; Mon, 20 Jun 2005 10:37:48 +0200 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1DkHnh-0005kk-7K for ged-emacs-devel@m.gmane.org; Mon, 20 Jun 2005 04:38:37 -0400 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1DkHjy-0005NJ-67 for emacs-devel@gnu.org; Mon, 20 Jun 2005 04:34:46 -0400 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1DkHji-0005Iv-2k for emacs-devel@gnu.org; Mon, 20 Jun 2005 04:34:31 -0400 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1DkHis-0004oA-DW for emacs-devel@gnu.org; Mon, 20 Jun 2005 04:33:38 -0400 Original-Received: from [64.233.162.206] (helo=zproxy.gmail.com) by monty-python.gnu.org with esmtp (Exim 4.34) id 1DkHZK-0006PF-RI for emacs-devel@gnu.org; Mon, 20 Jun 2005 04:23:46 -0400 Original-Received: by zproxy.gmail.com with SMTP id 40so695888nzk for ; Mon, 20 Jun 2005 01:21:06 -0700 (PDT) DomainKey-Signature: a=rsa-sha1; q=dns; c=nofws; s=beta; d=gmail.com; h=received:message-id:date:from:reply-to:to:subject:in-reply-to:mime-version:content-type:content-transfer-encoding:content-disposition:references; b=OuDRK4NwBVl6j8IOPUIza5DeEh6eT/dxEJRJLl2TdB3paQ7kgtvXStfZ0Ibch9vqj+w5hInHYfix2Zb3NWgIV9fWDNfYG5+Zd24ISgzszv0S29taMfpafqclVfz2Hv8j7k9Fjkz6EuOLpJK0EgbZmfKuiWGa/UBczpskJ0RtiPQ= Original-Received: by 10.36.96.18 with SMTP id t18mr2898667nzb; Mon, 20 Jun 2005 01:21:06 -0700 (PDT) Original-Received: by 10.36.100.6 with HTTP; Mon, 20 Jun 2005 01:21:06 -0700 (PDT) Original-To: emacs-devel@gnu.org In-Reply-To: Content-Disposition: inline X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:39158 X-Report-Spam: http://spam.gmane.org/gmane.emacs.devel:39158 On 6/20/05, Richard Stallman wrote: > How about this doc string? >=20 > (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 doublequot= es. > 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. --=20 "Cut your own wood and it will warm you twice" =09Regards, Yoni Rabkin Katzenell