docs: add clarification in docstring

scikit-tda · Nov 15, 2023 · 24dd323 · 24dd323
1 parent 3a4954a
commit 24dd323
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/dreimac/emcoords.py b/dreimac/emcoords.py
@@ -103,7 +103,8 @@ def get_representative_cocycle(self, cohomology_class, homological_dimension):
             Cohomological birth of the linear combination or single cocycle
         cocycle: ndarray(K, homological_dimension+2, dtype=int)
             Representative cocycle. First homological_dimension+1 columns are vertex indices,
-            and last column takes values in finite field corresponding to self._prime
+            and last column takes values in finite field corresponding to self._prime.
+            The number of rows K is the number of simplices on which the cocycle is non-zero.
         """
 
         assert isinstance(cohomology_class, int)