Skip to content

Commit 5c5e1ab

Browse files
refine docstring
1 parent 664acc0 commit 5c5e1ab

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/diffpy/labpdfproc/mud_calculator.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,7 @@ def _compute_single_mud(x_data, I_data):
8383

8484

8585
def compute_mud(filepath):
86-
"""
87-
compute the best-fit mu*D value from a z-scan file, removing the sample holder effect
86+
"""Compute the best-fit mu*D value from a z-scan file, removing the sample holder effect.
8887
8988
This function loads z-scan data and fits it to a model
9089
that convolves a top-hat function with I = I0 * e^{-mu * l}.
@@ -93,11 +92,12 @@ def compute_mud(filepath):
9392
Parameters
9493
----------
9594
filepath: str
96-
The path to the z-scan file
95+
The path to the z-scan file.
9796
9897
Returns
9998
-------
100-
a float contains the best-fit mu*D value
99+
mu*D: float
100+
The best-fit mu*D value.
101101
"""
102102
x_data, I_data = loadData(filepath, unpack=True)
103103
best_mud, _ = min((_compute_single_mud(x_data, I_data) for _ in range(20)), key=lambda pair: pair[1])

0 commit comments

Comments
 (0)