Finish overhauling the docstrings to numpy format.

[dunshire.git] / src / dunshire / matrices.py

diff --git a/src/dunshire/matrices.py b/src/dunshire/matrices.py
index 3670d8f1e07db9cb0de23bce7b9a3fdbea9b0dfb..5f47f97ffeef686d923dc94cad63cc718ea4e65b 100644 (file)
--- a/src/dunshire/matrices.py
+++ b/src/dunshire/matrices.py
@@ -156,6 +156,12 @@ def identity(domain_dim):
     matrix
         A ``domain_dim``-by-``domain_dim`` dense integer identity matrix.
 
+    Raises
+    ------
+
+    ValueError
+        If you ask for the identity on zero or fewer dimensions.
+
     Examples
     --------
 
@@ -191,6 +197,12 @@ def inner_product(vec1, vec2):
     float
         The inner product of ``vec1`` and ``vec2``.
 
+    Raises
+    ------
+
+    TypeError
+        If the lengths of ``vec1`` and ``vec2`` differ.
+
     Examples
     --------