From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Newsgroups: gmane.lisp.guile.devel Subject: Re: [PATCH] Turn on more documentation Date: Mon, 14 May 2012 17:26:31 -0400 Message-ID: <20120514212631.ICPJX.52159.root@cdptpa-web09-z01> References: NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Trace: dough.gmane.org 1337030802 21608 80.91.229.3 (14 May 2012 21:26:42 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Mon, 14 May 2012 21:26:42 +0000 (UTC) Cc: guile-devel@gnu.org To: Noah Lavine , =?utf-8?Q?Ludovic_Court=C3=A8s?= Original-X-From: guile-devel-bounces+guile-devel=m.gmane.org@gnu.org Mon May 14 23:26:41 2012 Return-path: Envelope-to: guile-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1SU2mv-0002oO-5x for guile-devel@m.gmane.org; Mon, 14 May 2012 23:26:41 +0200 Original-Received: from localhost ([::1]:47130 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SU2mu-0003qI-Hp for guile-devel@m.gmane.org; Mon, 14 May 2012 17:26:40 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:56081) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SU2mr-0003pY-Or for guile-devel@gnu.org; Mon, 14 May 2012 17:26:39 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1SU2mq-0001u7-0U for guile-devel@gnu.org; Mon, 14 May 2012 17:26:37 -0400 Original-Received: from cdptpa-omtalb.mail.rr.com ([75.180.132.120]:18178) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SU2mp-0001tT-TV for guile-devel@gnu.org; Mon, 14 May 2012 17:26:35 -0400 Authentication-Results: cdptpa-omtalb.mail.rr.com smtp.user=dsmich@roadrunner.com; auth=pass (LOGIN) X-Authority-Analysis: v=2.0 cv=bLSU0YCZ c=1 sm=0 a=qqOTQDgTV5wA:10 a=zTVDa7HKqxcA:10 a=IkcTkHD0fZMA:10 a=pGLkceISAAAA:8 a=QLukZSzNtJck5QCNoN4A:9 a=QEXdDO2ut3YA:10 a=MSl-tDqOz04A:10 a=UJpe99hltnTXGk3FIeyrjA==:117 X-Cloudmark-Score: 0 Original-Received: from [10.127.132.100] ([10.127.132.100:41922] helo=cdptpa-web09-z01) by cdptpa-oedge03.mail.rr.com (envelope-from ) (ecelerity 2.2.3.46 r()) with ESMTPA id BF/B5-29249-78871BF4; Mon, 14 May 2012 21:26:31 +0000 In-Reply-To: X-Priority: 3 (Normal) Sensitivity: Normal X-Originating-IP: X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 75.180.132.120 X-BeenThere: guile-devel@gnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: "Developers list for Guile, the GNU extensibility library" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guile-devel-bounces+guile-devel=m.gmane.org@gnu.org Original-Sender: guile-devel-bounces+guile-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.lisp.guile.devel:14426 Archived-At: ---- Noah Lavine wrote:=20 > Hello, >=20 > > From =E2=80=9COrganisation of this Manual=E2=80=9D: > > > > =C2=A0*Chapter 6: Guile API Reference* > > =C2=A0 =C2=A0 =C2=A0 This part of the manual documents the Guile API in > > =C2=A0 =C2=A0 =C2=A0 functionality-based groups with the Scheme and C i= nterfaces > > =C2=A0 =C2=A0 =C2=A0 presented side by side. > > > > =C2=A0*Chapter 7: Guile Modules* > > =C2=A0 =C2=A0 =C2=A0 Describes some important modules, distributed as p= art of the Guile > > =C2=A0 =C2=A0 =C2=A0 distribution, that extend the functionality provid= ed by the Guile > > =C2=A0 =C2=A0 =C2=A0 Scheme core. > > > > So I think the idea is for core functionality to be in Chapter 6, and > > =E2=80=9Cperipheral things=E2=80=9D to be in Chapter 7. =C2=A0The modul= es you mention would > > fall in the second category, I think. >=20 > That's certainly enough for this project, but I think in general this > distinction is not very clear. How would someone guess what > functionality is considered "core" and what functionality is an > extension? My first guess would be that things in the (guile) module > are core and everything else is an extension, but that is not the > case. Does this come from an earlier time when the Guile core was > distributed separately from the Guile libraries? >=20 > Unless there is going to be some other distinction between core and > extensions, it would seem more natural to me to document everything by > functionality, in the same part of the manual. Some sections would > correspond to modules, because modules are also supposed to group > things by functionality, but that would not be the rule for how the > manual worked. What do you think? I have always had a very difficult time trying to locate the documentation = for a module by drilling down through the info menus. I always seem to go = to the wrong section. I have much better results starting from an index. -Dale