Commit 969b8daf authored by Eli Bendersky's avatar Eli Bendersky

Issue #14202: some additional doc fixes

parent 16d84ac3
...@@ -44,11 +44,12 @@ Example:: ...@@ -44,11 +44,12 @@ Example::
Since the document is treated as a "flat" stream of events, the document "tree" Since the document is treated as a "flat" stream of events, the document "tree"
is implicitly traversed and the desired elements are found regardless of their is implicitly traversed and the desired elements are found regardless of their
depth in the tree. In other words, one does not need to consider hierarchical issues depth in the tree. In other words, one does not need to consider hierarchical
such as recursive searching of the document nodes, although if the context of issues such as recursive searching of the document nodes, although if the
elements were important, one would either need to maintain some context-related context of elements were important, one would either need to maintain some
state (ie. remembering where one is in the document at any given point) or to context-related state (i.e. remembering where one is in the document at any
make use of the :func:`DOMEventStream.expandNode` method and switch to DOM-related processing. given point) or to make use of the :func:`DOMEventStream.expandNode` method
and switch to DOM-related processing.
.. class:: PullDom(documentFactory=None) .. class:: PullDom(documentFactory=None)
...@@ -71,11 +72,9 @@ make use of the :func:`DOMEventStream.expandNode` method and switch to DOM-relat ...@@ -71,11 +72,9 @@ make use of the :func:`DOMEventStream.expandNode` method and switch to DOM-relat
If you have XML in a string, you can use the :func:`parseString` function instead: If you have XML in a string, you can use the :func:`parseString` function instead:
.. function:: parseString(string, parser=None) .. function:: parseString(string, parser=None)
Return a :class:`DOMEventStream` that represents the (unicode) *string*. Return a :class:`DOMEventStream` that represents the (Unicode) *string*.
.. data:: default_bufsize .. data:: default_bufsize
...@@ -84,7 +83,6 @@ If you have XML in a string, you can use the :func:`parseString` function instea ...@@ -84,7 +83,6 @@ If you have XML in a string, you can use the :func:`parseString` function instea
The value of this variable can be changed before calling :func:`parse` and The value of this variable can be changed before calling :func:`parse` and
the new value will take effect. the new value will take effect.
.. _domeventstream-objects: .. _domeventstream-objects:
DOMEventStream Objects DOMEventStream Objects
...@@ -93,16 +91,17 @@ DOMEventStream Objects ...@@ -93,16 +91,17 @@ DOMEventStream Objects
.. class:: DOMEventStream(stream, parser, bufsize) .. class:: DOMEventStream(stream, parser, bufsize)
.. method:: DOMEventStream.getEvent() .. method:: getEvent()
Return a tuple containing *event* and the current *node* as Return a tuple containing *event* and the current *node* as
:class:`xml.dom.minidom.Document` if event equals START_DOCUMENT, :class:`xml.dom.minidom.Document` if event equals :data:`START_DOCUMENT`,
:class:`xml.dom.minidom.Element` if event equals START_ELEMENT or :class:`xml.dom.minidom.Element` if event equals :data:`START_ELEMENT` or
END_ELEMENT or :class:`xml.dom.minidom.Text` if event equals CHARACTERS. :data:`END_ELEMENT` or :class:`xml.dom.minidom.Text` if event equals
:data:`CHARACTERS`.
The current node does not contain informations about its children, unless The current node does not contain informations about its children, unless
:func:`expandNode` is called. :func:`expandNode` is called.
.. method:: DOMEventStream.expandNode(node) .. method:: expandNode(node)
Expands all children of *node* into *node*. Example:: Expands all children of *node* into *node*. Example::
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment