From fc7ff342de909ebd8eaad7609ea49c333ad94416 Mon Sep 17 00:00:00 2001 From: Nao Pross Date: Tue, 5 Mar 2024 00:47:31 +0100 Subject: Improve docstring --- mdpoly/abc.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/mdpoly/abc.py b/mdpoly/abc.py index 6ec1712..c503029 100644 --- a/mdpoly/abc.py +++ b/mdpoly/abc.py @@ -23,7 +23,10 @@ class Expr(Protocol): @property @abstractmethod def shape(self) -> Shape: - """ Computes the shape of the expression. """ + """ Computes the shape of the expression. This method is also used to + check if the operation described by *Expr* can be perfomed with *left* + and *right*. If the shape cannot be computed because of an algebraic + problem raises :py:class:`mdpoly.errors.AlgebraicError`. """ def __repr__(self): name = self.__class__.__qualname__ -- cgit v1.2.1