Merge pull request #3593 from MechCoder/row_norms_doc_fix

jnothman · jnothman · commit d6bfe09b4e4e · 2014-08-27T00:22:05.000+10:00
[MRG] DOC: Added np.sqrt since default is 'squared=False'
diff --git a/sklearn/utils/extmath.py b/sklearn/utils/extmath.py
@@ -54,8 +54,8 @@ def squared_norm(x):
 def row_norms(X, squared=False):
     """Row-wise (squared) Euclidean norm of X.
 
-    Equivalent to (X * X).sum(axis=1), but also supports CSR sparse matrices
-    and does not create an X.shape-sized temporary.
+    Equivalent to np.sqrt((X * X).sum(axis=1)), but also supports CSR sparse
+    matrices and does not create an X.shape-sized temporary.
 
     Performs no input validation.
     """
