Document the new function.

mcmtroffaes · Sep 19, 2024 · 2eefff2 · 2eefff2
1 parent 56d0b82
commit 2eefff2
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/cython/pycddlib.pxi b/cython/pycddlib.pxi
@@ -348,7 +348,8 @@ def matrix_append_to(mat1: Matrix, mat2: Matrix) -> None:
 def redundant(
     mat: Matrix, row: int, strong: bool = False
 ) -> tuple[bool, Sequence[NumberType]]:
-    """Checks whether *row* is (strongly) redundant for the representation *mat*.
+    """Checks whether *row* is
+    (strongly if *strong* is ``True``) redundant for the representation *mat*.
     Linearity rows are not checked
     i.e. *row* should not be in the :attr:`~cdd.Matrix.lin_set`.
 

diff --git a/docs/source/cdd.rst b/docs/source/cdd.rst
@@ -87,6 +87,8 @@ Functions
 .. autofunction:: matrix_canonicalize
 .. autofunction:: matrix_rank
 
+.. autofunction:: redundant
+
 .. autofunction:: linprog_solve
 
 .. autofunction:: copy_input