diff --git a/news/doc.rst b/news/doc.rst new file mode 100644 index 0000000..476b2bd --- /dev/null +++ b/news/doc.rst @@ -0,0 +1,23 @@ +**Added:** + +* <news item> + +**Changed:** + +* <news item> + +**Deprecated:** + +* <news item> + +**Removed:** + +* <news item> + +**Fixed:** + +Fixed 3 typos in docstring of subroutines.py + +**Security:** + +* <news item> diff --git a/src/diffpy/snmf/subroutines.py b/src/diffpy/snmf/subroutines.py index ae7f7ef..bee3475 100644 --- a/src/diffpy/snmf/subroutines.py +++ b/src/diffpy/snmf/subroutines.py @@ -112,9 +112,9 @@ def construct_component_matrix(components): def construct_weight_matrix(components): """Constructs the weights matrix. - Constructs a ΔΆ x M matrix where K is the number of components and M is the + Constructs a K x M matrix where K is the number of components and M is the number of signals. Each element is the stretching factor for a specific - weights for a specific signal from the data input. + weight factor for a specific signal from the data input. Parameters ---------- @@ -359,7 +359,7 @@ def update_weights_matrix( The length of the experimental signal patterns stretching_factor_matrix: 2d array like - The matrx containing the stretching factors of the calculated component signals. Has dimensions K x M + The matrix containing the stretching factors of the calculated component signals. Has dimensions K x M where K is the number of component signals and M is the number of XRD/PDF patterns. component_matrix: 2d array like