diff options
| author | Nao Pross <np@0hm.ch> | 2024-03-05 00:47:31 +0100 |
|---|---|---|
| committer | Nao Pross <np@0hm.ch> | 2024-03-05 00:47:31 +0100 |
| commit | fc7ff342de909ebd8eaad7609ea49c333ad94416 (patch) | |
| tree | 6a47e6cb3687dd9e81ea727c6c49042851c6fa83 | |
| parent | Implement more shape checks (diff) | |
| download | mdpoly-fc7ff342de909ebd8eaad7609ea49c333ad94416.tar.gz mdpoly-fc7ff342de909ebd8eaad7609ea49c333ad94416.zip | |
Improve docstring
| -rw-r--r-- | mdpoly/abc.py | 5 |
1 files changed, 4 insertions, 1 deletions
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__ |