From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: ludo@gnu.org (Ludovic =?iso-8859-1?Q?Court=E8s?=) Newsgroups: gmane.lisp.guile.devel Subject: Re: r6rs library documentation Date: Wed, 05 May 2010 23:12:57 +0200 Message-ID: <871vdq9hnq.fsf@gnu.org> References: NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Trace: dough.gmane.org 1273106878 30752 80.91.229.12 (6 May 2010 00:47:58 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Thu, 6 May 2010 00:47:58 +0000 (UTC) To: guile-devel@gnu.org Original-X-From: guile-devel-bounces+guile-devel=m.gmane.org@gnu.org Thu May 06 02:47:55 2010 connect(): No such file or directory Return-path: Envelope-to: guile-devel@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by lo.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1O9pFk-0001lB-UL for guile-devel@m.gmane.org; Thu, 06 May 2010 02:47:50 +0200 Original-Received: from localhost ([127.0.0.1]:56210 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1O9p3O-0001CP-Et for guile-devel@m.gmane.org; Wed, 05 May 2010 20:35:02 -0400 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1O9lu7-0002fE-GH for guile-devel@gnu.org; Wed, 05 May 2010 17:13:15 -0400 Original-Received: from [140.186.70.92] (port=48007 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1O9lu4-0002dI-QM for guile-devel@gnu.org; Wed, 05 May 2010 17:13:14 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.69) (envelope-from ) id 1O9lu3-00053c-2y for guile-devel@gnu.org; Wed, 05 May 2010 17:13:12 -0400 Original-Received: from lo.gmane.org ([80.91.229.12]:35879) by eggs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1O9lu2-00053N-O3 for guile-devel@gnu.org; Wed, 05 May 2010 17:13:11 -0400 Original-Received: from list by lo.gmane.org with local (Exim 4.69) (envelope-from ) id 1O9lty-0002Ce-2Q for guile-devel@gnu.org; Wed, 05 May 2010 23:13:06 +0200 Original-Received: from acces.bordeaux.inria.fr ([193.50.110.5]) by main.gmane.org with esmtp (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Wed, 05 May 2010 23:13:06 +0200 Original-Received: from ludo by acces.bordeaux.inria.fr with local (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Wed, 05 May 2010 23:13:06 +0200 X-Injected-Via-Gmane: http://gmane.org/ connect(): No such file or directory Original-Lines: 52 Original-X-Complaints-To: usenet@dough.gmane.org X-Gmane-NNTP-Posting-Host: acces.bordeaux.inria.fr X-URL: http://www.fdn.fr/~lcourtes/ X-Revolutionary-Date: 16 =?iso-8859-1?Q?Flor=E9al?= an 218 de la =?iso-8859-1?Q?R=E9volution?= X-PGP-Key-ID: 0xEA52ECF4 X-PGP-Key: http://www.fdn.fr/~lcourtes/ludovic.asc X-PGP-Fingerprint: 83C4 F8E5 10A3 3B4C 5BEA D15D 77DD 95E2 EA52 ECF4 X-OS: x86_64-unknown-linux-gnu User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/23.1 (gnu/linux) Cancel-Lock: sha1:DuaYfXHt7X8ljRlwo16+4cQAEv0= X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) X-BeenThere: guile-devel@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Developers list for Guile, the GNU extensibility library" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: guile-devel-bounces+guile-devel=m.gmane.org@gnu.org Errors-To: guile-devel-bounces+guile-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.lisp.guile.devel:10317 Archived-At: Hi Julian! Julian Graham writes: > As per Andy's suggestion, I'd like to start adding some documentation > for the R6RS library code Ive been working on, and I wanted to get a > sense of where that documentation should go. Nice! > My initial feeling is that there are two documentation sections to be > created: A description of Guile's implementation of the R6RS `library' > and `import' forms; and some notes on the bits of the R6RS "Standard > Libraries" that Guile provides, along with pointers to more formal > specs. I'd say the first part should go in api-modules.texi (right > after "R6RS Version References"), Agreed. > whereas the second should go into its own file and be included > somewhere near "Standard Libraries" (which could be renamed to "Guile > Standard Libraries") in guile.texi. I think the main section could be “R6RS Standard Libraries”, right after “SRFI Support”, and could be organized similarly to “SRFI Support”, i.e., with one node per module. Bytevectors and (rnrs io ports) are already documented in other places because they provide functionality not available elsewhere in Guile. These sections would stay where they are and would be linked to in “R6RS Standard Libraries”. There could be other R6RS modules deserving similar treatment, such as fixnums & flonums, but their current implementation just builds upon bignums and inexact numbers so it’s probably not worth promoting them at this point. Apart from that all R6RS modules seem to provide functionality more or less available elsewhere so they could happily stay under “R6RS Standard Libraries”. What do you think? Besides, I would find it convenient if there were xrefs between the “R6RS Standard Libraries” sub-sections and the rest of the manual. For instance, the SRFI-9/record/R6RS record nodes could link to each other, ideally with one sentence indicating how they differ. Well, this is all quite ambitious and I’m glad you’re volunteering! :-) Thanks, Ludo’.