Fixed docstrings.

OxfordRSE · Dec 4, 2024 · 80c8348 · 80c8348
1 parent aa98637
commit 80c8348
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 4 deletions.
diff --git a/l2gv2/clustering.py b/l2gv2/clustering.py
@@ -262,7 +262,7 @@ def louvain_clustering(graph: TGraph, *args, **kwargs):
     arguments provided are passed through.
 
     References:
-        .. V. D. Blondel et al.
+        .. [#l] V. D. Blondel et al.
            “Fast unfolding of communities in large networks”.
            Journal of Statistical Mechanics: Theory and Experiment 2008.10 (2008), P10008.
            DOI: `10.1088/1742-5468/2008/10/P10008`
@@ -278,7 +278,7 @@ def louvain_clustering(graph: TGraph, *args, **kwargs):
 
 def metis_clustering(graph: TGraph, num_clusters):
     """
-    Implements clustering using metis
+    Implements clustering using metis [#metis]_
 
     Args:
         graph: input graph

diff --git a/l2gv2/sparsify.py b/l2gv2/sparsify.py
@@ -87,10 +87,13 @@ def resistance_sparsify(
 
     Args:
         graph: input graph
+
         target_mean_degree: desired mean degree after sparsification
+
         ensure_connected: if ``True``, first add edges of a maximum spanning tree
-            based on the resistance weights to ensure that the
-            sparsified graph remains connected if the input graph is connected
+                          based on the resistance weights to ensure that the
+                          sparsified graph remains connected if the input graph is connected
+
         epsilon: tolerance for effective resistance computation
 
     Returns: