From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Noah Lavine Newsgroups: gmane.lisp.guile.devel Subject: Re: [PATCH] Turn on more documentation Date: Mon, 7 May 2012 08:30:20 -0400 Message-ID: References: <87ehqxzke9.fsf@gnu.org> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=windows-1252 Content-Transfer-Encoding: quoted-printable X-Trace: dough.gmane.org 1336393836 2078 80.91.229.3 (7 May 2012 12:30:36 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Mon, 7 May 2012 12:30:36 +0000 (UTC) Cc: guile-devel@gnu.org To: =?ISO-8859-1?Q?Ludovic_Court=E8s?= Original-X-From: guile-devel-bounces+guile-devel=m.gmane.org@gnu.org Mon May 07 14:30:35 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 1SRN5G-0002Jm-2H for guile-devel@m.gmane.org; Mon, 07 May 2012 14:30:34 +0200 Original-Received: from localhost ([::1]:58211 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SRN5F-0000TU-E2 for guile-devel@m.gmane.org; Mon, 07 May 2012 08:30:33 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:59085) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SRN57-0000TC-Hg for guile-devel@gnu.org; Mon, 07 May 2012 08:30:30 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1SRN55-0001mr-Kz for guile-devel@gnu.org; Mon, 07 May 2012 08:30:25 -0400 Original-Received: from mail-yw0-f41.google.com ([209.85.213.41]:65034) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SRN55-0001lu-EL; Mon, 07 May 2012 08:30:23 -0400 Original-Received: by yhr47 with SMTP id 47so5013693yhr.0 for ; Mon, 07 May 2012 05:30:21 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=mime-version:sender:in-reply-to:references:date :x-google-sender-auth:message-id:subject:from:to:cc:content-type :content-transfer-encoding; bh=g1c5HxntzoglmPZ33WBnGGruvymJsE13kHxykG0CDq0=; b=SLTxFvSL512wo2jsrpvQDOE8Ma5EcDgIbqwPwulH1mm8dbQUiib1AqYl3uC2Ic3fZN Zoe9vYPlcOl90xP7CMx3a7pgZ4c/5e/EE//OwX/RxrDwuc/mtndssvNL+F1zNaxInke3 57j+p0wsnXwAzikIO8s4+fOnZvDl6h1a4m0iQrpgCJpBrO2rvvdA7sjLh2UvreGslsH5 Rs6hTvG78IWWgUvQqxZjzVL2iNVl6rhphzClj3k9MM51MXRbxNk2SLmCtMjQ4EW9V4G0 HSL/h9zJbMWAvWlI8RO+KDN2lr4DJsqG/n/4zO3xIAnz/xLUNbscJbn7aZfz9zZgafOm GTyA== Original-Received: by 10.50.47.132 with SMTP id d4mr4943836ign.7.1336393820960; Mon, 07 May 2012 05:30:20 -0700 (PDT) Original-Received: by 10.42.29.200 with HTTP; Mon, 7 May 2012 05:30:20 -0700 (PDT) In-Reply-To: <87ehqxzke9.fsf@gnu.org> X-Google-Sender-Auth: zTzqwE2Kef1fSKPOHahMYyH4eq8 X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 209.85.213.41 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:14367 Archived-At: Hello, > The problem is that the auto-generated =93Standard Library=94 section loo= ks > very poor in comparison to the rest of the manual. =A0So 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 =93Standard > Library=94). I could do that pretty easily, but I'm afraid that documentation that isn't in the same file as the code would tend to be updated less often than documentation in the same file. It might not be a problem though, and I'm happy to try. The other alternative is to make our documentation format more expressive, but that might be a lot of trouble. > However, I believe Thien-Thi=92s Guile 1.4 has good doc for at least some > of these modules, and it would be great if it could be incorporated. > > WDYT? That would be ideal, but I was concerned that the documentation wasn't copyrighted by the FSF. Unless Thien-Thi is interested in contributing it, of course. Noah