Changeset 517 for trunk/genshi/input.py

Timestamp:

Mar 22, 2007, 1:45:18 PM (17 years ago)

Author:

cmlenz

Message:

Try to use proper reStructuredText for docstrings throughout.

File:

• trunk/genshi/input.py (modified) (4 diffs)

trunk/genshi/input.py

@@ -12 +12 @@
 # history and logs, available at http://genshi.edgewall.org/log/.
 
+"""Support for constructing markup streams from files, strings, or other
+sources.
+"""
+
 from itertools import chain
 from xml.parsers import expat
@@ -28 +32 @@
 
 __all__ = ['ET', 'ParseError', 'XMLParser', 'XML', 'HTMLParser', 'HTML']
+__docformat__ = 'restructuredtext en'
 
 def ET(element):
@@ -82 +87 @@
         """Initialize the parser for the given XML input.
         
-        @param source: the XML text as a file-like object
-        @param filename: the name of the file, if appropriate
-        @param encoding: the encoding of the file; if not specified, the
-            encoding is assumed to be ASCII, UTF-8, or UTF-16, or whatever the
-            encoding specified in the XML declaration (if any)
+        :param source: the XML text as a file-like object
+        :param filename: the name of the file, if appropriate
+        :param encoding: the encoding of the file; if not specified, the
+                         encoding is assumed to be ASCII, UTF-8, or UTF-16, or
+                         whatever the encoding specified in the XML declaration
+                         (if any)
         """
         self.source = source
@@ -260 +266 @@
         """Initialize the parser for the given HTML input.
         
-        @param source: the HTML text as a file-like object
-        @param filename: the name of the file, if known
-        @param filename: encoding of the file; ignored if the input is unicode
+        :param source: the HTML text as a file-like object
+        :param filename: the name of the file, if known
+        :param filename: encoding of the file; ignored if the input is unicode
         """
         html.HTMLParser.__init__(self)