Docstrings and simplifications of domains.py

[linpy.git] / doc / polyhedra.rst

diff --git a/doc/polyhedra.rst b/doc/polyhedra.rst
index 779be46..1f2756b 100644 (file)
--- a/doc/polyhedra.rst
+++ b/doc/polyhedra.rst
@@ -1,58 +1,56 @@
 Polyhedra Module
 ================
 
 Polyhedra Module
 ================
 

+Polyhedron class allows users to build and inspect polyherons.
+

 .. py:class:: Polyhedron
 
 .. py:class:: Polyhedron
 

-    Polyhedron class allows users to build and inspect polyherons.  The following methods provide the properties of a polyhedron. 
+    .. py:property:: equalities
+
+        Returns a list of the equalities in a polyhedron.
+
+    .. py:property:: inequalities

 
 

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

 
 

-    .. py:method:: constraints(self)
-    
-        Return ta list of the constraints of a polyhedron.
+    .. py:property:: constraints
+
+        Returns a list of the constraints of a polyhedron.

 
 

-    The following unary operations can be used to inspect a polyhedron.
-    

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

-    
+

         Returns a polyhedron as a disjoint.
         Returns a polyhedron as a disjoint.

-               
+

     .. py:method:: isuniverse(self)
     .. py:method:: isuniverse(self)

-    
-        Return ``True`` if a polyhedron is the Universe set.    
+
+        Return ``True`` if a polyhedron is the Universe set.

 
     .. py:method:: subs(self, symbol, expression=None)
 
     .. py:method:: subs(self, symbol, expression=None)

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

 
 

-To create a polyhedron, the user must use the folloing functions to define the equalities and inequalities which are the contraints of a polyhedron.
-   
+        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 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*.