HYP-364 Fix doctrings

pnnl · Jan 3, 2024 · c16dc01 · c16dc01
1 parent 72dedbe
commit c16dc01
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/hypernetx/algorithms/homology_mod2.py b/hypernetx/algorithms/homology_mod2.py
@@ -1,4 +1,4 @@
-"""
+r"""
 Homology and Smith Normal Form
 ==============================
 The purpose of computing the Homology groups for data generated
@@ -541,7 +541,7 @@ def reduced_row_echelon_form_mod2(M):
 
 
 def boundary_group(image_basis):
-    """
+    r"""
     Returns a csr_matrix with rows corresponding to the elements of the
     group  generated by image basis over $\mathbb{Z}_2$
 
@@ -734,7 +734,7 @@ def betti_numbers(h, k=None):
 
 
 def homology_basis(bd, k=None, boundary=False, **kwargs):
-    """
+    r"""
     Compute a basis for the kth-simplicial homology group, $H_k$, defined by a
     chain complex $C$ with boundary maps given by bd $= \{k:\partial_k \}$
 

diff --git a/hypernetx/algorithms/laplacians_clustering.py b/hypernetx/algorithms/laplacians_clustering.py
@@ -39,7 +39,7 @@
 
 
 def prob_trans(H, weights=False, index=True, check_connected=True):
-    """
+    r"""
     The probability transition matrix of a random walk on the vertices of a hypergraph.
     At each step in the walk, the next vertex is chosen by:
-Original file line number
+Diff line change
@@ Expand Up / @@ -39,7 +39,7 @@ @@
     def prob_trans(H, weights=False, index=True, check_connected=True):
-        """
+        r"""
         The probability transition matrix of a random walk on the vertices of a hypergraph.
         At each step in the walk, the next vertex is chosen by:
@@ Expand Down @@