unofficial mirror of guile-devel@gnu.org 
 help / color / mirror / Atom feed
From: ludo@gnu.org (Ludovic Courtès)
To: Noah Lavine <noah.b.lavine@gmail.com>
Cc: guile-devel@gnu.org
Subject: Re: [PATCH] Turn on more documentation
Date: Mon, 07 May 2012 16:31:23 +0200	[thread overview]
Message-ID: <87lil4vz9g.fsf@gnu.org> (raw)
In-Reply-To: <CA+U71=Ps0Y6QEQfkJUz5nVvmDg1iXtXiThi=5R=jHzZxM6_kVA@mail.gmail.com> (Noah Lavine's message of "Mon, 7 May 2012 08:30:20 -0400")

Hi!

Noah Lavine <noah.b.lavine@gmail.com> skribis:

> Hello,
>
>> 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”).
>
> 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.

All of our manual except “Standard Library” is maintained this way.  It
takes discipline to keep up-to-date, but it also leads to a better
manual IMO.

>> 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?
>
> 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.

Yes, I was hoping he would be reading us, let’s see.  ;-)

Thanks,
Ludo’.



  reply	other threads:[~2012-05-07 14:31 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-05-03  3:20 [PATCH] Turn on more documentation Noah Lavine
2012-05-03 22:07 ` Noah Lavine
2012-05-06 10:14 ` Ludovic Courtès
2012-05-07 12:30   ` Noah Lavine
2012-05-07 14:31     ` Ludovic Courtès [this message]
2012-05-12 20:56       ` Noah Lavine
2012-05-14 12:47         ` Ludovic Courtès
2012-05-14 14:05           ` Noah Lavine
2012-05-14 15:00             ` Ludovic Courtès
2012-05-14 15:14               ` Noah Lavine
2012-05-15 20:24                 ` Andy Wingo
2012-05-15 21:25                   ` Ludovic Courtès
2012-05-16  0:19                     ` Noah Lavine
2012-05-14 21:26             ` dsmich
2012-05-15 20:19   ` Andy Wingo

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/guile/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87lil4vz9g.fsf@gnu.org \
    --to=ludo@gnu.org \
    --cc=guile-devel@gnu.org \
    --cc=noah.b.lavine@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).