Skip to content

Commit 1187bdf

Browse files
committed
Reformatted docstrings
1 parent 839f40e commit 1187bdf

1 file changed

Lines changed: 8 additions & 5 deletions

File tree

diffpy/snmf/containers.py

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ class ComponentSignal:
77
Attributes
88
----------
99
grid: 1d array of floats
10-
The vector containing the grid points of the component
10+
The vector containing the grid points of the component.
1111
iq: 1d array of floats
12-
The intensity/g(r) values of the component
12+
The intensity/g(r) values of the component.
1313
weights: 1d array of floats
14-
The vector containing the weight of the component signal for each signal
14+
The vector containing the weight of the component signal for each signal.
1515
stretching_factors: 1d array of floats
16-
The vector containing the stretching factor for the component signal for each signal
16+
The vector containing the stretching factor for the component signal for each signal.
1717
id: int
18-
The component number.
18+
The number identifying the component.
1919
"""
2020

2121
def __init__(self, grid, number_of_signals, id_number, perturbation=1e-3):
@@ -27,10 +27,12 @@ def __init__(self, grid, number_of_signals, id_number, perturbation=1e-3):
2727

2828
def apply_stretch(self, m):
2929
"""Applies a stretching factor to a component
30+
3031
Parameters
3132
----------
3233
m: int
3334
The index specifying which stretching factor to apply
35+
3436
Returns
3537
-------
3638
tuple of 1d arrays
@@ -59,6 +61,7 @@ def apply_weight(self, m, stretched_component=None):
5961
The index specifying with weight to apply
6062
stretched_component: 1d array
6163
The 1d array containing a stretched component.
64+
6265
Returns
6366
-------
6467
1d array

0 commit comments

Comments
 (0)