From e589475458bafdb05f12355e8059180a1ac9fd0d Mon Sep 17 00:00:00 2001
From: David Vierra <codewarrior@hawaii.rr.com>
Date: Thu, 21 Apr 2016 16:28:21 -1000
Subject: [PATCH] Rewrite docstrings

---
 src/mceditlib/transform.py | 51 ++++++++++++++++++++++++++++++++------
 1 file changed, 44 insertions(+), 7 deletions(-)

diff --git a/src/mceditlib/transform.py b/src/mceditlib/transform.py
index 3afadd5..ccafabe 100644
--- a/src/mceditlib/transform.py
+++ b/src/mceditlib/transform.py
@@ -211,13 +211,24 @@ class DimensionTransformBase(object):
 class SelectionTransform(DimensionTransformBase):
     def __init__(self, dimension, selection):
         """
+        SelectionTransform is a simple wrapper around a dimension that restricts
+        the blocks and chunks in the dimension to those selected by the given
+        selection. It can be used anywhere a WorldEditorDimension is usable.
 
-        :param dimension:
-        :type dimension:
-        :param selection:
-        :type selection: SelectionBox
-        :return:
-        :rtype:
+        Parameters
+        ----------
+
+        dimension: WorldEditorDimension
+            The dimension to restrict
+
+        selection: ISelection
+            The selection to apply
+
+        Returns
+        -------
+
+        transformedDimension: SelectionTransform
+            A wrapper around the dimension, displaying only the selected blocks.
         """
         super(SelectionTransform, self).__init__(dimension)
         self._transformedBounds = selection
@@ -238,7 +249,33 @@ class SelectionTransform(DimensionTransformBase):
                 section.Data[sectionMask] = baseSection.Data[sectionMask]
 
 class DimensionTransform(DimensionTransformBase):
-    def __init__(self, dimension, anchor, rotX, rotY, rotZ):
+    """
+    A wrapper around a WorldEditorDimension that applies a three-dimensional rotation
+    around a given anchor point. The wrapped dimension's bounds will be different from the
+    original dimension.
+
+    Parameters
+    ----------
+
+    dimension: WorldEditorDimension
+        The dimension to wrap and apply rotations to
+
+    anchor: Vector
+        The point to rotate the dimension around
+
+    rotX: float
+    rotY: float
+    rotZ: float
+        The angles to rotate the dimension around, along each axis respectively.
+        The angles are given in radians.
+
+    Returns
+    -------
+
+    transformedDimension: DimensionTransform
+        A dimension that acts as a rotated version of the given dimension.
+    """
+    def __init__(self, dimension, anchor, rotX=0, rotY=0, rotZ=0):
         super(DimensionTransform, self).__init__(dimension)
         self.rotX = rotX
         self.rotY = rotY