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: [PATCH] Turn on more documentation Date: Sun, 06 May 2012 12:14:22 +0200 Message-ID: <87ehqxzke9.fsf@gnu.org> References: NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Trace: dough.gmane.org 1336299285 17029 80.91.229.3 (6 May 2012 10:14:45 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Sun, 6 May 2012 10:14:45 +0000 (UTC) To: guile-devel@gnu.org Original-X-From: guile-devel-bounces+guile-devel=m.gmane.org@gnu.org Sun May 06 12:14:45 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 1SQyUF-0006P9-LO for guile-devel@m.gmane.org; Sun, 06 May 2012 12:14:43 +0200 Original-Received: from localhost ([::1]:53678 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SQyUE-0008Ht-VM for guile-devel@m.gmane.org; Sun, 06 May 2012 06:14:42 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:47261) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SQyUC-0008Hm-50 for guile-devel@gnu.org; Sun, 06 May 2012 06:14:41 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1SQyUA-0000nK-DR for guile-devel@gnu.org; Sun, 06 May 2012 06:14:39 -0400 Original-Received: from plane.gmane.org ([80.91.229.3]:55994) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SQyUA-0000mv-69 for guile-devel@gnu.org; Sun, 06 May 2012 06:14:38 -0400 Original-Received: from list by plane.gmane.org with local (Exim 4.69) (envelope-from ) id 1SQyU5-0006Hb-Ez for guile-devel@gnu.org; Sun, 06 May 2012 12:14:33 +0200 Original-Received: from reverse-83.fdn.fr ([80.67.176.83]) by main.gmane.org with esmtp (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Sun, 06 May 2012 12:14:33 +0200 Original-Received: from ludo by reverse-83.fdn.fr with local (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Sun, 06 May 2012 12:14:33 +0200 X-Injected-Via-Gmane: http://gmane.org/ Original-Lines: 27 Original-X-Complaints-To: usenet@dough.gmane.org X-Gmane-NNTP-Posting-Host: reverse-83.fdn.fr X-URL: http://www.fdn.fr/~lcourtes/ X-Revolutionary-Date: 18 =?iso-8859-1?Q?Flor=E9al?= an 220 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.110018 (No Gnus v0.18) Emacs/24.0.93 (gnu/linux) Cancel-Lock: sha1:nHx18Ah2YRZPeHi/bELJEn+u2fU= X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 80.91.229.3 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:14361 Archived-At: Hi, Noah Lavine skribis: > As part of my investigation into modules that don't have > documentation, I discovered that several modules in ice-9/ actually > have usable documentation that we are just not using in our build > process. (For reference, everything in the "Standard Library" section > of the manual is snarfed from .scm source files.) This patch makes > Guile build documentation for (ice-9 binary-ports), (ice-9 > common-list), (ice-9 documentation), (ice-9 gap-buffer), (ice-9 runq), > (ice-9 serialize), and (ice-9 time). It gets incorporated into the > manual as part of the "Standard Library" section. The problem is that the auto-generated “Standard Library” section looks very poor in comparison to the rest of the manual. So we should really try hard to write good doc by hands for these, and come up with a handy structure (instead of one node per module, all under “Standard Library”). However, I believe Thien-Thi’s Guile 1.4 has good doc for at least some of these modules, and it would be great if it could be incorporated. WDYT? Thanks, Ludo’.