summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorEli Bendersky <eliben@gmail.com>2012-03-16 14:49:58 (GMT)
committerEli Bendersky <eliben@gmail.com>2012-03-16 14:49:58 (GMT)
commit969b8daf5a825f8137a10bb64d91fdbf07c5b27f (patch)
tree735168206747e151fc190e649352607b9a8e1fe4 /Doc
parent16d84ac355c532a1e7d25cf75e0b577923de2856 (diff)
downloadcpython-969b8daf5a825f8137a10bb64d91fdbf07c5b27f.zip
cpython-969b8daf5a825f8137a10bb64d91fdbf07c5b27f.tar.gz
cpython-969b8daf5a825f8137a10bb64d91fdbf07c5b27f.tar.bz2
Issue #14202: some additional doc fixes
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/xml.dom.pulldom.rst27
1 files changed, 13 insertions, 14 deletions
diff --git a/Doc/library/xml.dom.pulldom.rst b/Doc/library/xml.dom.pulldom.rst
index 7dd38c0..eb16a09 100644
--- a/Doc/library/xml.dom.pulldom.rst
+++ b/Doc/library/xml.dom.pulldom.rst
@@ -44,11 +44,12 @@ Example::
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
-depth in the tree. In other words, one does not need to consider hierarchical issues
-such as recursive searching of the document nodes, although if the context of
-elements were important, one would either need to maintain some context-related
-state (ie. remembering where one is in the document at any given point) or to
-make use of the :func:`DOMEventStream.expandNode` method and switch to DOM-related processing.
+depth in the tree. In other words, one does not need to consider hierarchical
+issues such as recursive searching of the document nodes, although if the
+context of elements were important, one would either need to maintain some
+context-related state (i.e. remembering where one is in the document at any
+given point) or to make use of the :func:`DOMEventStream.expandNode` method
+and switch to DOM-related processing.
.. class:: PullDom(documentFactory=None)
@@ -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:
-
.. 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
@@ -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 new value will take effect.
-
.. _domeventstream-objects:
DOMEventStream Objects
@@ -93,16 +91,17 @@ DOMEventStream Objects
.. class:: DOMEventStream(stream, parser, bufsize)
- .. method:: DOMEventStream.getEvent()
+ .. method:: getEvent()
Return a tuple containing *event* and the current *node* as
- :class:`xml.dom.minidom.Document` if event equals START_DOCUMENT,
- :class:`xml.dom.minidom.Element` if event equals START_ELEMENT or
- END_ELEMENT or :class:`xml.dom.minidom.Text` if event equals CHARACTERS.
+ :class:`xml.dom.minidom.Document` if event equals :data:`START_DOCUMENT`,
+ :class:`xml.dom.minidom.Element` if event equals :data:`START_ELEMENT` or
+ :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
:func:`expandNode` is called.
- .. method:: DOMEventStream.expandNode(node)
+ .. method:: expandNode(node)
Expands all children of *node* into *node*. Example::