update bandwidth docstring

KrishnaswamyLab · Nov 17, 2018 · a46804a · a46804a
1 parent 324a547
commit a46804a
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git a/graphtools/api.py b/graphtools/api.py
@@ -63,6 +63,11 @@ def Graph(data,
     decay : `int` or `None`, optional (default: 10)
         Rate of alpha decay to use. If `None`, alpha decay is not used.
 
+    bandwidth : `float`, list-like or `None`, optional (default: `None`)
+        Fixed bandwidth to use. If given, overrides `knn`. Can be a single
+        bandwidth or a list-like (shape=[n_samples]) of bandwidths for each
+        sample.
+
     distance : `str`, optional (default: `'euclidean'`)
         Any metric from `scipy.spatial.distance` can be used
         distance metric for building kNN graph.

diff --git a/graphtools/graphs.py b/graphtools/graphs.py
@@ -38,7 +38,7 @@ class kNNGraph(DataGraph):
 
     bandwidth : `float`, list-like or `None`, optional (default: `None`)
         Fixed bandwidth to use. If given, overrides `knn`. Can be a single
-        bandwidth or a list-like (shape=[n_samples]) or bandwidths for each
+        bandwidth or a list-like (shape=[n_samples]) of bandwidths for each
         sample.
         TODO: implement `callable` bandwidth
 
@@ -641,7 +641,7 @@ class TraditionalGraph(DataGraph):
 
     bandwidth : `float`, list-like or `None`, optional (default: `None`)
         Fixed bandwidth to use. If given, overrides `knn`. Can be a single
-        bandwidth or a list-like (shape=[n_samples]) or bandwidths for each
+        bandwidth or a list-like (shape=[n_samples]) of bandwidths for each
         sample.
         TODO: implement `callable` bandwidth
 

diff --git a/test/test_api.py b/test/test_api.py
@@ -4,6 +4,8 @@
     build_graph,
     raises,
 )
+import warnings
+
 import igraph
 import numpy as np
 import graphtools