Skip to content

Commit c783a02

Browse files
author
John Halloran
committed
docstring typo
1 parent d39cbe0 commit c783a02

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

src/diffpy/snmf/snmf_class.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,10 @@ def __init__(
4848
The stretching factor that influences the decomposition. Zero corresponds to no
4949
stretching present. Relatively insensitive and typically adjusted in powers of 10.
5050
eta : float
51-
The sparsity factor than influences the decomposition. Should be set to zero for
51+
The sparsity factor that influences the decomposition. Should be set to zero for
5252
non-sparse data such as PDF. Can be used to improve results for sparse data such
5353
as XRD, but due to instability, should be used only after first selecting the
54-
best value for rho.
54+
best value for rho. Suggested adjustment is by powers of 2.
5555
max_iter : int
5656
The maximum number of times to update each of A, X, and Y before stopping
5757
the optimization.

0 commit comments

Comments
 (0)