In documentation, say that LinExpr.__eq__() does not return a Polyhedron

[linpy.git] / doc / reference.rst

diff --git a/doc/reference.rst b/doc/reference.rst
index 4a2c419..07ceaf3 100644 (file)
--- a/doc/reference.rst
+++ b/doc/reference.rst
@@ -164,6 +164,8 @@ For example, if ``x`` is a :class:`Symbol`, then ``x + 1`` is an instance of :cl
     .. method:: __eq__(expr)
 
         Test whether two linear expressions are equal.
+        Unlike methods :meth:`LinExpr.__lt__`, :meth:`LinExpr.__le__`, :meth:`LinExpr.__ge__`, :meth:`LinExpr.__gt__`, the result is a boolean value, not a polyhedron.
+        To express that two linear expressions are equal or not equal, use functions :func:`Eq` and :func:`Ne` instead.
 
     As explained below, it is possible to create polyhedra from linear expressions using comparison methods.