[docs] [issue14009] Clearer documentation for cElementTree

Eli Bendersky report at bugs.python.org
Thu Feb 16 04:59:53 CET 2012


Eli Bendersky <eliben at gmail.com> added the comment:

If you want to collect additional feedback, you may want to add some other people to the Nosy list :-) Alternatively, since it's a small doc change you can just commit it and it can be fixed later if someone strongly objects.

>>>
This:

  The :class:`Element` type is a flexible container object, designed to store
  hierarchical data structures in memory.  The type can be described as a cross
  between a list and a dictionary.

?  Yeah, it’s not quite good.
>>>

Yes. You read the first section of a module's doc and you have *no idea* what the module is and how to use it. I plant to work on this for 3.3 in the context of issue 14006.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue14009>
_______________________________________


More information about the docs mailing list