[Patches] [Patch #101821] xmldomminidom.tex: Documentation for minidom

Martin von Loewis loewis@informatik.hu-berlin.de
Tue, 24 Oct 2000 22:50:25 +0200 (MET DST)


> Rejected; we can't include a huge chunk of IDL in the documentation
> both because it breaks formatting of the typeset version and it just
> doesn't seem appropriate (the XML-SIG has already ascertained that
> the IDL is screwed up and largely ignored).

Hi Fred,

I don't think that rationale for rejection is valid: I can fix the
formatting of the typeset version if you want (e.g. by not setting it
as a minipage). 

On not being appropriate: The IDL provides documentation that the
English text doesn't. For example, the it doesn't tell what the
functions return in many cases (e.g. {remove|append}Child). Also, a
number of functions that are implemented and ought to be part of the
interface are not documented (e.g. getAttributeNode). Using the IDL
would provide a better guarantee of consistency.

As for the IDL being screwed: I don't know whether this was a XML-SIG
statement (or rather one of individuals); it is certainly not true for
DOM Level 1 Second Edition or DOM Level 2 (which the patch proposed to
include).

I can accept that the IDL is not included in the documentation, but
I'd like to see the content that it would have provided written in
plain English, then.

Regards,
Martin