Implement Line2 docstrings

* docs/Geometry.rst - Use autoclass for Line2
* pygorithm/geometry/axisall.py - fix incorrect tuple syntax, add missing
vartypes on ivars
* pygorithm/geometry/line2.py - skeleton code
* pygorithm/geometry/vector2.py - add missing vartypes on ivars, add
magnitude_squared.

Author: Tjstretchalot

docs/Geometry.rst

@@ -66,97 +66,10 @@ Vector2
 Line2
 -----
 
-.. class:: Line2
-
-Defines a two-dimensional directed line segment defined by two points. 
-This class is mostly used as a way to cache information that is 
-regularly required when working on geometrical problems.
-
-.. note::
-
-    Lines should be used as if they were completely immutable to ensure 
-    correctness. All attributes of Line2 can be reconstructed from the two 
-    points, and thus cannot be changed on their own and must be recalculated 
-    if there were any changes to `start` or `end`. 
-
-.. note::
-
-    To prevent unnecessary recalculations, many functions on lines accept an 
-    'offset' argument, which is used to perform calculations on lines that 
-    are simply shifts of other lines.
-
-.. attribute:: Line2.start
-
-    `Vector2` the start of this line
-    
-.. attribute:: Line2.end
-
-    `Vector2` the end of this line
-    
-.. attribute:: Line2.delta
-
-    `Vector2` from start to end
-
-.. attribute:: Line2.axis
-
-    `Vector2` normalized `delta`
-
-.. attribute:: Line2.normal
-
-    `Vector2` normalized normal of `axis`
-
-.. attribute:: Line2.magnitude_squared
-
-    `numerical` square of the magnitude of the line
-    
-.. attribute:: Line2.magnitude
-
-    `numerical` magnitude of the line
-    
-.. attribute:: Line2.min_x
-
-    `numerical` minimum x-value on the line
-    
-.. attribute:: Line2.min_y
-
-    `numerical` minimum y-value on the line
-
-.. attribute:: Line2.max_x
-
-    `numerical` maximum x-value on the line
-    
-.. attribute:: Line2.max_y
-
-    `numerical` maximum y-value on the line
-    
-.. attribute:: Line2.slope
-
-    `numerical` (including +inf and -inf) slope of the line
-    
-.. attribute:: Line2.y_intercept
-
-    `numerical or None` y_intercept of the line (or None if `vertical`)
-    
-.. attribute:: Line2.horizontal
-
-    `bool` true if ``slope == 0``, false otherwise
-    
-.. attribute:: Line2.vertical 
-
-    `bool` true if ``slope == float('+inf') or slope == float('-inf')``, false otherwise
-    
-.. staticmethod:: intersects_line(line1, line2, offset1, offset2)
-
-    - **line1**        - `Line2` first line
-    - **line2**        - `Line2` second line
-    - **offset1**      - `Vector2` offset of first line
-    - **offset2**      - `Vector2` offset of second line
-    - **Return Value** - `bool, bool` touches, overlaps
+.. autoclass:: pygorithm.geometry.line2.Line2
+    :members:
+    :special-members:
 
-    Determines if the two lines at the specified offsets are touching and/or
-    overlapping. Two lines touch if they share endpoints, two lines overlap 
-    if they intersect on any point that is not an endpoint.
-
 Axis-Aligned Line
 -----------------
 

pygorithm/geometry/axisall.py

@@ -39,8 +39,11 @@ class AxisAlignedLine(object):
         into them.
     
     :ivar axis: the axis this line is on
+    :vartype axis: :class:`pygorithm.geometry.vector2.Vector2`
     :ivar min: the point closest to negative infinity
+    :vartype min: :class:`numbers.Number`
     :ivar max: the point closest to positive infinity
+    :vartype max: :class:`numbers.Number`
     """
 
     def __init__(self, axis, point1, point2):
@@ -77,8 +80,8 @@ def intersects(line1, line2):
         :type line1: :class:`pygorithm.geometry.axisall.AxisAlignedLine`
         :param line2: the second line
         :type line2: :class:`pygorithm.geometry.axisall.AxisAlignedLine`
-        :returns: touching, overlapping
-        :rtype: bool, bool
+        :returns: (touching, overlapping)
+        :rtype: (bool, bool)
         """
 
         pass
@@ -104,8 +107,8 @@ def find_intersection(line1, line2):
         :type line1: :class:`pygorithm.geometry.axisall.AxisAlignedLine`
         :param line2: the second line
         :type line2: :class:`pygorithm.geometry.axisall.AxisAlignedLine`
-        :returns: touching, mtv against 1
-        :rtype: bool, :class:`numbers.Number` or None
+        :returns: (touching, mtv against 1)
+        :rtype: (bool, :class:`numbers.Number` or None)
         """
 
         pass
@@ -125,7 +128,7 @@ def contains_point(line, point):
         :type line: :class:`pygorithm.geometry.axisall.AxisAlignedLine`
         :param point: the point
         :type point: :class:`numbers.Number`
-        :returns: if the point is an edge of the line, if the point is contained by the line
-        :rtype: bool, bool
+        :returns: (if the point is an edge of the line, if the point is contained by the line)
+        :rtype: (bool, bool)
         """
         pass