[Lxml-checkins] r44844 - lxml/trunk/src/lxml

[scoder at codespeak.net]

Author: scoder
Date: Sun Jul  8 11:24:59 2007
New Revision: 44844

Modified:
   lxml/trunk/src/lxml/etree.pyx
Log:
doc update

Modified: lxml/trunk/src/lxml/etree.pyx
==============================================================================
--- lxml/trunk/src/lxml/etree.pyx	(original)
+++ lxml/trunk/src/lxml/etree.pyx	Sun Jul  8 11:24:59 2007
@@ -1917,6 +1917,13 @@
 def HTML(text, _BaseParser parser=None, base_url=None):
     """Parses an HTML document from a string constant. This function can be used
     to embed "HTML literals" in Python code.
+
+    To override the parser with a different ``HTMLParser`` you can pass it to
+    the ``parser`` keyword argument.
+
+    The ``base_url`` keyword argument allows to set the original base URL of
+    the document to support relative Paths when looking up external entities
+    (DTD, XInclude, ...).
     """
     cdef _Document doc
     if parser is None:
@@ -1929,6 +1936,13 @@
 def XML(text, _BaseParser parser=None, base_url=None):
     """Parses an XML document from a string constant. This function can be used
     to embed "XML literals" in Python code.
+
+    To override the parser with a different ``XMLParser`` you can pass it to
+    the ``parser`` keyword argument.
+
+    The ``base_url`` keyword argument allows to set the original base URL of
+    the document to support relative Paths when looking up external entities
+    (DTD, XInclude, ...).
     """
     cdef _Document doc
     if parser is None: