[issue11379] Remove "lightweight" from minidom description
Stefan Behnel
report at bugs.python.org
Mon Nov 28 19:54:19 CET 2011
Stefan Behnel <scoder at users.sourceforge.net> added the comment:
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.
"""
----------
_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue11379>
_______________________________________
More information about the Python-bugs-list
mailing list