[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: (ice-9 documentation) `find-documentation' to be exported
From: |
thi |
Subject: |
Re: (ice-9 documentation) `find-documentation' to be exported |
Date: |
Fri, 27 Apr 2001 17:58:35 -0700 |
From: Neil Jerram <address@hidden>
Date: 25 Apr 2001 21:55:08 +0100
I worked out what I was trying to say :-)
find-documentation is quite a good name, and I think that the
combination of find-documentation and module name `documentation'
should be reserved for when we have a better picture of what the
complete documentation system will look like.
Therefore, I would be quite happy with either of the following:
1) Rename find-documentation to something more specific like
`find-documentation-in-files' and export it under this name.
2) Move the file-based documentation procedures into a more
specifically named module, e.g. `(ice-9 file-documentation)', and
export them from that module using the current names.
What do you think?
i think i'll backtrack from exporting anything besides what is there
already (for now, and instead do some orthogonal documentation
enhancements. i had a patch from 2000-sep that i just merged in. to
self-demo, do a cvs update, and then in a fresh guile invocation:
(help (ice-9 documentation))
to see that writeup i promised. please feel free to modify my initial
stab at documenting Guile Documentation Format Version 2 (and correct
any factual errors regarding Version 1).
in any case, i'm hoping this kind of facility encourages we developers
to go into a mad commentary spree before the next release, and makes it
compelling for guile users to have an easy standardized (and yet still
customizable) way to record and present non-resident information. this
revolutionary concept means the enablement of unprecedent levels of
(insert more sales spew here... :-)
thi