Docstrings and simplifications of domains.py

[linpy.git] / doc / linexpr.rst

diff --git a/doc/linexpr.rst b/doc/linexpr.rst
index 4101252..b5d8069 100644 (file)
--- a/doc/linexpr.rst
+++ b/doc/linexpr.rst
@@ -1,7 +1,10 @@
 Linear Expression Module
 ========================
 
 Linear Expression Module
 ========================
 

-This class implements linear expressions.
+This class implements linear expressions. A linear expression is….
+
+.. py:class:: Expression
+

 
     .. py:method:: coefficient(self, symbol)
         
 
     .. py:method:: coefficient(self, symbol)
         


@@ -11,21 +14,21 @@ This class implements linear expressions.
         
         Return a list of the coefficients of an expression
         
         
         Return a list of the coefficients of an expression
         

-    .. py:method:: constant(self)
+    .. attribute:: constant

     
         Return the constant value of an expression.
         
     
         Return the constant value of an expression.
         

-    .. py:method:: symbols(self)
+    .. attribute:: symbols

     
         Return a list of symbols in an expression.                            
     
     
         Return a list of symbols in an expression.                            
     

-    .. py:method:: dimension(self)
+    .. attribute:: dimension

     
     

-        Return the number of vriables in an expression.
+        Return the number of variables in an expression.

         
     .. py:method:: __sub__(self, other)
     
         
     .. py:method:: __sub__(self, other)
     

-        Return the difference between two expressions.
+        Return the difference between *self* and *other*.

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


@@ -38,6 +41,9 @@ This class implements linear expressions.
     .. py:method:: tosympy(self)
     
         Return an expression as a sympy object.    
     .. py:method:: tosympy(self)
     
         Return an expression as a sympy object.    

+
+.. py:class:: Symbol(Expression)
+        

           
 .. py:class:: Dummy(Symbol)
 
           
 .. py:class:: Dummy(Symbol)