From mboxrd@z Thu Jan 1 00:00:00 1970 Path: main.gmane.org!not-for-mail From: Alex Schroeder Newsgroups: gmane.emacs.xemacs.design,gmane.emacs.devel Subject: Re: INFO on add-ons Date: Thu, 05 Sep 2002 00:40:15 +0200 Sender: xemacs-design-admin@xemacs.org Message-ID: <87d6rttm40.fsf@emacswiki.org> References: <3D728E82.8000808@cox.net> <87vg5pe4pr.fsf@emacswiki.org> <3D73F919.5010706@cox.net> <873csqr8b9.fsf@emacswiki.org> <87u1l6pok2.fsf@emacswiki.org> NNTP-Posting-Host: localhost.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: main.gmane.org 1031179048 22067 127.0.0.1 (4 Sep 2002 22:37:28 GMT) X-Complaints-To: usenet@main.gmane.org NNTP-Posting-Date: Wed, 4 Sep 2002 22:37:28 +0000 (UTC) Return-path: Original-Received: from gwyn.tux.org ([207.96.1.200]) by main.gmane.org with esmtp (Exim 3.35 #1 (Debian)) id 17mim6-0005jX-00 for ; Thu, 05 Sep 2002 00:37:26 +0200 Original-Received: from gwyn.tux.org (localhost.localdomain [127.0.0.1]) by gwyn.tux.org (8.9.3/8.9.1) with ESMTP id SAA08321; Wed, 4 Sep 2002 18:39:01 -0400 Original-Received: (from turnbull@localhost) by gwyn.tux.org (8.9.3/8.9.1) id SAA08291 for xemacs-design-mailman@xemacs.org; Wed, 4 Sep 2002 18:38:21 -0400 Original-Received: (from mail@localhost) by gwyn.tux.org (8.9.3/8.9.1) id SAA08287 for turnbull@tux.org; Wed, 4 Sep 2002 18:38:21 -0400 Original-Received: from relay02.cablecom.net (relay02.cablecom.net [62.2.33.102]) by gwyn.tux.org (8.9.3/8.9.1) with ESMTP id SAA08283 for ; Wed, 4 Sep 2002 18:38:20 -0400 Original-Received: from smtp.swissonline.ch (mail-4.swissonline.ch [62.2.32.85]) by relay02.cablecom.net (8.12.5/8.12.5/SOL/AWF/MXRELAY/20020820) with ESMTP id g84Mc1Ws065216; Thu, 5 Sep 2002 00:38:17 +0200 (CEST) (envelope-from alex@emacswiki.org) Original-Received: from confusibombus (dclient217-162-239-98.hispeed.ch [217.162.239.98]) by smtp.swissonline.ch (8.11.6/8.11.6/SMTPSOL/AWF/2002040101) with ESMTP id g84Mc1H19246; Thu, 5 Sep 2002 00:38:01 +0200 (MEST) Original-Received: from alex by confusibombus with local (Exim 3.35 #1 (Debian)) id 17miop-0000B2-00; Thu, 05 Sep 2002 00:40:15 +0200 Original-To: emacs-devel@gnu.org, xemacs-design@xemacs.org X-Face: ^BC$`[IcggstLPyen&dqF+b2'zyK#r.mU*'Nms}@&4zw%SJ#5!/7SMVjBS7'lb;QK)|IPU5U'o1'522W4TyzB3Ab*IBo^iw]l4|kUbdZuUDO6=Um-.4IzhNiV'B"@K#jy_(wW|Zbk[34flKY^|PrQ?$u2\fKg^]AY>wOX#H32i In-Reply-To: (Miles Bader's message of "04 Sep 2002 10:39:37 +0900") Original-Lines: 24 User-Agent: Gnus/5.090008 (Oort Gnus v0.08) Emacs/21.2.90 (i686-pc-linux-gnu) X-XEmacs-List: design Errors-To: xemacs-design-admin@xemacs.org X-BeenThere: xemacs-design@xemacs.org X-Mailman-Version: 2.0.1 Precedence: bulk List-Help: List-Post: List-Subscribe: , List-Id: Discussion of design and features for XEmacs. List-Unsubscribe: , Xref: main.gmane.org gmane.emacs.xemacs.design:1394 gmane.emacs.devel:7488 X-Report-Spam: http://spam.gmane.org/gmane.emacs.devel:7488 Miles Bader writes: > Alex Schroeder writes: >> Only if doc strings and commentaries (readable via package finder in >> Emacs, perhaps there needs to be a better interface?) fail, should we >> need to write Info. As I said this is for newbies, and pulling stuff >> together. > > I use doc-strings more often in my daily work, but I think info files > are very useful for getting a broader view of a package. I don't think > we should avoid writing manual entries just because there are > doc-strings Totally correct. That is what I meant by "pulling stuff" together. The idea of writing a texinfo page for every package, however, is overkill. We only need a texinfo page when a broader view of a package is required. In sql.el, for example, there is a sql-help defun, and all the entry points have enough information to get you started. And it is not so complex as to merit a manual. I am not saying a manual is useless. I am saying that requiring a manual at all times is useless. Alex.