From: Andy Wingo <wingo@pobox.com>
To: Ian Price <ianprice90@googlemail.com>
Cc: guile-devel@gnu.org
Subject: Re: SXML documentation
Date: Fri, 16 Dec 2011 15:33:22 +0100 [thread overview]
Message-ID: <87zkes8u31.fsf@pobox.com> (raw)
In-Reply-To: <8739cku6t2.fsf@Kagami.home> (Ian Price's message of "Fri, 16 Dec 2011 10:52:57 +0000")
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/
prev parent reply other threads:[~2011-12-16 14:33 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-12-16 10:52 SXML documentation Ian Price
2011-12-16 14:33 ` Andy Wingo [this message]
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=87zkes8u31.fsf@pobox.com \
--to=wingo@pobox.com \
--cc=guile-devel@gnu.org \
--cc=ianprice90@googlemail.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).