From mboxrd@z Thu Jan 1 00:00:00 1970 Path: main.gmane.org!not-for-mail From: Luc Teirlinck Newsgroups: gmane.emacs.devel Subject: Re: doc elisp intro cross reference fixes Date: Tue, 18 Nov 2003 23:05:10 -0600 (CST) Sender: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Message-ID: <200311190505.hAJ55Ap02510@raven.dms.auburn.edu> References: <87wua28zux.fsf@zip.com.au> <87ad6vdsxi.fsf@mail.jurta.org> <200311190418.hAJ4ITC02466@raven.dms.auburn.edu> NNTP-Posting-Host: deer.gmane.org X-Trace: sea.gmane.org 1069218753 18658 80.91.224.253 (19 Nov 2003 05:12:33 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Wed, 19 Nov 2003 05:12:33 +0000 (UTC) Cc: bob@rattlesnake.com, rms@gnu.org, emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Wed Nov 19 06:12:30 2003 Return-path: Original-Received: from quimby.gnus.org ([80.91.224.244]) by deer.gmane.org with esmtp (Exim 3.35 #1 (Debian)) id 1AMKdi-0005Lz-00 for ; Wed, 19 Nov 2003 06:12:30 +0100 Original-Received: from monty-python.gnu.org ([199.232.76.173]) by quimby.gnus.org with esmtp (Exim 3.35 #1 (Debian)) id 1AMKdi-0000pn-00 for ; Wed, 19 Nov 2003 06:12:30 +0100 Original-Received: from localhost ([127.0.0.1] helo=monty-python.gnu.org) by monty-python.gnu.org with esmtp (Exim 4.24) id 1AMLaJ-00086e-S7 for emacs-devel@quimby.gnus.org; Wed, 19 Nov 2003 01:13:03 -0500 Original-Received: from list by monty-python.gnu.org with tmda-scanned (Exim 4.24) id 1AMLaE-00084Z-JA for emacs-devel@gnu.org; Wed, 19 Nov 2003 01:12:58 -0500 Original-Received: from mail by monty-python.gnu.org with spam-scanned (Exim 4.24) id 1AMLZh-00073D-Nn for emacs-devel@gnu.org; Wed, 19 Nov 2003 01:12:57 -0500 Original-Received: from [131.204.53.104] (helo=manatee.dms.auburn.edu) by monty-python.gnu.org with esmtp (Exim 4.24) id 1AMLZg-00071r-RL; Wed, 19 Nov 2003 01:12:24 -0500 Original-Received: from raven.dms.auburn.edu (raven.dms.auburn.edu [131.204.53.29]) by manatee.dms.auburn.edu (8.12.10/8.12.10) with ESMTP id hAJ5B0Kk015209; Tue, 18 Nov 2003 23:11:00 -0600 (CST) Original-Received: (from teirllm@localhost) by raven.dms.auburn.edu (8.11.6+Sun/8.11.6) id hAJ55Ap02510; Tue, 18 Nov 2003 23:05:10 -0600 (CST) X-Authentication-Warning: raven.dms.auburn.edu: teirllm set sender to teirllm@dms.auburn.edu using -f Original-To: monnier@IRO.UMontreal.CA In-reply-to: (message from Stefan Monnier on 18 Nov 2003 23:29:51 -0500) X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.2 Precedence: list List-Id: Emacs development discussions. List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Xref: main.gmane.org gmane.emacs.devel:17907 X-Report-Spam: http://spam.gmane.org/gmane.emacs.devel:17907 Stefan Monnier wrote: After (defcustom foobar 1 "hello"), set-variable is quite happy to let me set the variable `foobar'. Indeed, I was wrong on that one. Here is the (I believe) correct answer to when to use or not to use * in a defcustom (from (elisp)Documentation Tips): * A variable's documentation string should start with `*' if the variable is one that users would often want to set interactively. If the value is a long list, or a function, or if the variable would be set only in init files, then don't start the documentation string with `*'. *Note Defining Variables::. One might nevertheless want to allow users to customize variables of the latter type through Custom. Sincerely, Luc.