Final fixes and cleanup before release.

Author: earwig

README.rst

@@ -1,5 +1,5 @@
 mwparserfromhell
-========================
+================
 
 **mwparserfromhell** (the *MediaWiki Parser from Hell*) is a Python package
 that provides an easy-to-use and outrageously powerful parser for MediaWiki_

mwparserfromhell/smart_list.py

@@ -289,17 +289,21 @@ def __iadd__(self, other):
 
     @property
     def _start(self):
+        """The starting index of this list, inclusive."""
         return self._sliceinfo[0]
 
     @property
     def _stop(self):
+        """The ending index of this list, exclusive."""
         return self._sliceinfo[1]
 
     @property
     def _step(self):
+        """The number to increase the index by between items."""
         return self._sliceinfo[2]
 
     def _render(self):
+        """Return the actual list from the stored start/stop/step."""
         return list(self._parent)[self._start:self._stop:self._step]
 
     @inheritdoc

mwparserfromhell/utils.py

@@ -27,7 +27,6 @@
 
 from __future__ import unicode_literals
 
-import mwparserfromhell
 from .compat import bytes, str
 from .nodes import Node
 from .smart_list import SmartList
@@ -44,24 +43,26 @@ def parse_anything(value):
     :py:class:`~.Template`, such as :py:meth:`wikicode.insert()
     <.Wikicode.insert>` or setting :py:meth:`template.name <.Template.name>`.
     """
-    wikicode = mwparserfromhell.wikicode.Wikicode
-    if isinstance(value, wikicode):
+    from . import parse
+    from .wikicode import Wikicode
+
+    if isinstance(value, Wikicode):
         return value
     elif isinstance(value, Node):
-        return wikicode(SmartList([value]))
+        return Wikicode(SmartList([value]))
     elif isinstance(value, str):
-        return mwparserfromhell.parse(value)
+        return parse(value)
     elif isinstance(value, bytes):
-        return mwparserfromhell.parse(value.decode("utf8"))
+        return parse(value.decode("utf8"))
     elif isinstance(value, int):
-        return mwparserfromhell.parse(str(value))
+        return parse(str(value))
     elif value is None:
-        return wikicode(SmartList())
+        return Wikicode(SmartList())
     try:
         nodelist = SmartList()
         for item in value:
             nodelist += parse_anything(item).nodes
     except TypeError:
         error = "Needs string, Node, Wikicode, int, None, or iterable of these, but got {0}: {1}"
         raise ValueError(error.format(type(value).__name__, value))
-    return wikicode(nodelist)
+    return Wikicode(nodelist)

mwparserfromhell/wikicode.py

@@ -143,6 +143,7 @@ def _get_tree(self, code, lines, marker, indent):
         the starting indentation.
         """
         def write(*args):
+            """Write a new line following the proper indentation rules."""
             if lines and lines[-1] is marker:  # Continue from the last line
                 lines.pop()  # Remove the marker
                 last = lines.pop()