From d68da37d78fc862ea560b23108d97385e60cefb9 Mon Sep 17 00:00:00 2001 From: Filippo Ballerini Date: Tue, 29 Oct 2024 16:39:54 -0400 Subject: [PATCH 1/4] Fixed some typos --- src/diffpy/snmf/subroutines.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/diffpy/snmf/subroutines.py b/src/diffpy/snmf/subroutines.py index ae7f7ef7..bee3475a 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 From 5a4c27a6ba991dd9e801abc8520c5aa50fde8552 Mon Sep 17 00:00:00 2001 From: Filippo Ballerini Date: Tue, 29 Oct 2024 16:39:54 -0400 Subject: [PATCH 2/4] Fixed typos in docstring of subroutines.py --- src/diffpy/snmf/subroutines.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/diffpy/snmf/subroutines.py b/src/diffpy/snmf/subroutines.py index ae7f7ef7..bee3475a 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 From b3d1d465a83bd59e82f4329a807deb7f97a27178 Mon Sep 17 00:00:00 2001 From: Filippo Ballerini Date: Wed, 30 Oct 2024 12:20:12 -0400 Subject: [PATCH 3/4] Added comment under **Fixed:** in doc.rst --- news/doc.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 news/doc.rst diff --git a/news/doc.rst b/news/doc.rst new file mode 100644 index 00000000..4b5a264b --- /dev/null +++ b/news/doc.rst @@ -0,0 +1,25 @@ +**Added:** + +* + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +Fixed 3 typos in docstring of subroutines.py + +* + +**Security:** + +* From f1607d279489633fa129a3116a11252e69ee027a Mon Sep 17 00:00:00 2001 From: Filippo Ballerini Date: Wed, 30 Oct 2024 12:33:21 -0400 Subject: [PATCH 4/4] Removed undesirable comment --- news/doc.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/news/doc.rst b/news/doc.rst index 4b5a264b..476b2bda 100644 --- a/news/doc.rst +++ b/news/doc.rst @@ -18,8 +18,6 @@ Fixed 3 typos in docstring of subroutines.py -* - **Security:** *