Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed typos in docstring of subroutines.py #126

Closed
wants to merge 5 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions news/doc.rst
Original file line number Diff line number Diff line change
@@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please see comment in the other PR. We don't need a news item for just correcting typos.


**Security:**

* <news item>
6 changes: 3 additions & 3 deletions src/diffpy/snmf/subroutines.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
----------
Expand Down Expand Up @@ -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
Expand Down