SXML documentation

SXML documentation

[Ian Price]

Hi guilers,

The documentation for this in the manual is pretty sparse. Is it
possible to lift the documentation for the procedures in the source up
to the manual where people who don't read the source can find it?

As an example, the function 'find-string-from-port?' in (sxml ssax
input-parse) has the signature
  find-string-from-port? _ _ . _ 
which is not particularly meaningful. Or how would I know what the
'ssax:xml->sxml' argument 'namespace-prefix-assig' is if I didn't know
already?

-- 
Ian Price

"Programming is like pinball. The reward for doing it well is
the opportunity to do it again" - from "The Wizardy Compiled"

Re: SXML documentation

[Andy Wingo]

On Fri 16 Dec 2011 11:52, Ian Price <ianprice90@googlemail.com> writes:

> Hi guilers,
>
> The documentation for this in the manual is pretty sparse. Is it
> possible to lift the documentation for the procedures in the source up
> to the manual where people who don't read the source can find it?
>
> As an example, the function 'find-string-from-port?' in (sxml ssax
> input-parse) has the signature
>   find-string-from-port? _ _ . _ 
> which is not particularly meaningful. Or how would I know what the
> 'ssax:xml->sxml' argument 'namespace-prefix-assig' is if I didn't know
> already?

It probably needs to be rewritten.  It was part of an experiment to do
literate documentation, and it's pretty illiterate in the end.

Any patches to improve this situation are most welcome.

Andy
-- 
http://wingolog.org/