Docstrings and simplifications of domains.py

[linpy.git] / doc / polyhedra.rst

diff --git a/doc/polyhedra.rst b/doc/polyhedra.rst
index 605dded..1f2756b 100644 (file)
--- a/doc/polyhedra.rst
+++ b/doc/polyhedra.rst
@@ -4,18 +4,18 @@ Polyhedra Module
 Polyhedron class allows users to build and inspect polyherons.
 
 .. py:class:: Polyhedron
 Polyhedron class allows users to build and inspect polyherons.
 
 .. py:class:: Polyhedron

-    
-    .. py:property:: equalities(self)

 
 

-        Return a list of the equalities in a polyhedron.
+    .. py:property:: equalities

 
 

-    .. py:method:: inequalities(self)
+        Returns a list of the equalities in a polyhedron.

 
 

-        Return a list of the inequalities in a polyhedron.
+    .. py:property:: inequalities

 
 

-    .. py:method:: constraints(self)
+        Returns a list of the inequalities in a polyhedron.

 
 

-        Return ta list of the constraints of a polyhedron.
+    .. py:property:: constraints
+
+        Returns a list of the constraints of a polyhedron.

 
     .. py:method:: disjoint(self)
 
 
     .. py:method:: disjoint(self)
 


@@ -27,30 +27,30 @@ Polyhedron class allows users to build and inspect polyherons.
 
     .. py:method:: subs(self, symbol, expression=None)
 
 
     .. py:method:: subs(self, symbol, expression=None)
 

-        Subsitutes an expression into a polyhedron and returns the result.
+        Substitutes an expression into a polyhedron and returns the result.

 
 

-To create a polyhedron, the user can use the following functions to define  equalities and inequalities as the contraints.
+To create a polyhedron, the user can use the following functions to define  equalities and inequalities as the constraints.

 
 .. py:function:: Eq(left, right)
 
 
 .. py:function:: Eq(left, right)
 

-   Create a constraint by setting *left* equal to *right*.
+   Returns a Polyhedron instance with a single constraint as *left* equal to *right*.

 
 .. py:function:: Ne(left, right)
 
 
 .. py:function:: Ne(left, right)
 

-    Create a constraint by setting *left* not equal to *right*.
+   Returns a Polyhedron instance with a single constraint as *left* not equal to *right*.

 
 .. py:function:: Lt(left, right)
 
 
 .. py:function:: Lt(left, right)
 

-   Create a constraint by setting *left* less than *right*.
+   Returns a Polyhedron instance with a single constraint as *left* less than *right*.

 
 .. py:function:: Le(left, right)
 
 
 .. py:function:: Le(left, right)
 

-   Create a constraint by setting *left* less than or equal to *right*.
+   Returns a Polyhedron instance with a single constraint as *left* less than or equal to *right*.

 
 .. py:function:: Gt(left, right)
 
 
 .. py:function:: Gt(left, right)
 

-   Create a constraint by setting *left* greater than *right*.
+   Returns a Polyhedron instance with a single constraint as *left* greater than *right*.

 
 .. py:function:: Ge(left, right)
 
 
 .. py:function:: Ge(left, right)
 

-   Create a constraint by setting *left* greater than or equal to *right*.
+   Returns a Polyhedron instance with a single constraint as *left* greater than or equal to *right*.