From mboxrd@z Thu Jan 1 00:00:00 1970 Path: main.gmane.org!not-for-mail From: Simon Josefsson Newsgroups: gmane.emacs.devel Subject: Re: The minibuffer vs. Dialog Boxes (Re: Making XEmacs be more up-to-date) Date: Mon, 22 Apr 2002 14:59:04 +0200 (CEST) Sender: emacs-devel-admin@gnu.org Message-ID: References: NNTP-Posting-Host: localhost.gmane.org Mime-Version: 1.0 Content-Type: TEXT/PLAIN; charset=US-ASCII X-Trace: main.gmane.org 1019480432 18532 127.0.0.1 (22 Apr 2002 13:00:32 GMT) X-Complaints-To: usenet@main.gmane.org NNTP-Posting-Date: Mon, 22 Apr 2002 13:00:32 +0000 (UTC) Cc: Miles Bader , , Return-path: Original-Received: from quimby.gnus.org ([80.91.224.244]) by main.gmane.org with esmtp (Exim 3.33 #1 (Debian)) id 16zdQm-0004on-00 for ; Mon, 22 Apr 2002 15:00:32 +0200 Original-Received: from fencepost.gnu.org ([199.232.76.164]) by quimby.gnus.org with esmtp (Exim 3.12 #1 (Debian)) id 16zdRT-0004ey-00 for ; Mon, 22 Apr 2002 15:01:16 +0200 Original-Received: from localhost ([127.0.0.1] helo=fencepost.gnu.org) by fencepost.gnu.org with esmtp (Exim 3.34 #1 (Debian)) id 16zdQZ-00009b-00; Mon, 22 Apr 2002 09:00:19 -0400 Original-Received: from 178.230.13.217.in-addr.dgcsystems.net ([217.13.230.178] helo=yxa.extundo.com) by fencepost.gnu.org with esmtp (Exim 3.34 #1 (Debian)) id 16zdPT-0008WS-00; Mon, 22 Apr 2002 08:59:12 -0400 Original-Received: from yxa.extundo.com (localhost.localdomain [127.0.0.1]) by yxa.extundo.com (8.12.2/8.12.2) with ESMTP id g3MCx4KY004707; Mon, 22 Apr 2002 14:59:04 +0200 Original-Received: from localhost (jas@localhost) by yxa.extundo.com (8.12.2/8.12.1/Submit) with ESMTP id g3MCx4ll004704; Mon, 22 Apr 2002 14:59:04 +0200 X-Authentication-Warning: yxa.extundo.com: jas owned process doing -bs Original-To: Per Abrahamsen In-Reply-To: Errors-To: emacs-devel-admin@gnu.org X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.0.9 Precedence: bulk List-Help: List-Post: List-Subscribe: , List-Id: Emacs development discussions. List-Unsubscribe: , List-Archive: Xref: main.gmane.org gmane.emacs.devel:3029 X-Report-Spam: http://spam.gmane.org/gmane.emacs.devel:3029 On Mon, 22 Apr 2002, Per Abrahamsen wrote: > Simon Josefsson writes: > > > Making all code that displays or parse docstrings somehow support > > :link as well isn't the best approach. > > How much code is that, apart from describe-variable and > customize-variable (which should be one)? I wasn't objecting to changing the code based on the amount of code (which I'm sure is quite small) but because it means people handling docstrings need to have a mental model that not all documentation for a symbol is stored in the docstring, and that they may need to look elsewhere as well to get the complete picture. If all documentation (including references) is stored within the docstring, people handling docstrings will get all of the documentation without having to know or care about this at all. In any case, I think we agree that the real problem is to get lisp programmers to start to add references and having them end up as visible to the user. The way it is implemented isn't interesting or important (but that hasn't stopped me from having an opinion before ;-)). Suggestion: Add something to the Lisp manual on how to write docstrings that have references when defining symbols. I haven't seen the "See Info node" magic explained anywhere.