This is the mail archive of the
guile@sourceware.cygnus.com
mailing list for the Guile project.
RE: Doc: ideas and status
- To: "'Greg J. Badros'" <gjb at cs dot washington dot edu>, Gregg Reynolds <greynolds at enteract dot com>
- Subject: RE: Doc: ideas and status
- From: "Reynolds, Gregg" <greynolds at datalogics dot com>
- Date: Tue, 21 Dec 1999 09:41:39 -0600
- Cc: guile at sourceware dot cygnus dot com
> -----Original Message-----
> From: Greg J. Badros [mailto:gjb@cs.washington.edu]
> Sent: Monday, December 20, 1999 11:59 AM
>
> Gregg Reynolds <greynolds@enteract.com> writes:
>
> > Something I forgot to add: we needn't put docstrings in the
> funcdefs for
> > RnRS stuff; instead we can markup the RnRS source with
> unique IDs, and
> > cross reference.
>
> I think it's better to have the guile docstrings be self-contained.
> We're not going to want to require linking to an RnRS document for you
> to get run-time documentation on, e.g., `map'.
>
Realized on the train this morning that I forgot the most compelling
argument for shunting the docstring text into separate file(s):
localization. Seems reasonable to provide doc support across multiple
natural languages.
For each such language a configuration option would support building for
that language only
--docstrings-en-GB
--docstrings-fr-CH
etc
and something like --docstrings-dyn would support runtime selection.
-gregg