This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author scoder
Recipients docs@python, loewis, pitrou, scoder
Date 2011-11-28.18:54:18
SpamBayes Score 6.0209433e-09
Marked as misclassified No
Message-id <1322506459.35.0.757622498929.issue11379@psf.upfronthosting.co.za>
In-reply-to
Content
Ok, so, what do we make of this? I proposed improvements to the wording in the documentation, which make it much clearer for users what they are buying into when they start using minidom. I still think that "factually correct" but clearly misleading documentation is not helpful and that it needs fixing. Here is an updated phrasing that I hope we can settle on:

"""
:mod:`xml.dom.minidom` --- Pure Python DOM implementation

[...]

:mod:`xml.dom.minidom` is a pure Python implementation of the Document Object Model interface, as known from other programming languages. It is intended to provide a smaller and simpler API than the full W3C DOM.

Note that MiniDOM has a several times larger memory footprint than :mod:`xml.etree.ElementTree`, the light-weight Python XML library in the standard library. If you do not need a (mostly) compliant W3C DOM implementation, but a fast and memory friendly XML tree implementation with an easy to learn API, use that instead.
"""
History
Date User Action Args
2011-11-28 18:54:19scodersetrecipients: + scoder, loewis, pitrou, docs@python
2011-11-28 18:54:19scodersetmessageid: <1322506459.35.0.757622498929.issue11379@psf.upfronthosting.co.za>
2011-11-28 18:54:18scoderlinkissue11379 messages
2011-11-28 18:54:18scodercreate