Skip to content

Commit a77a34d

Browse files
committed
doc: update return value explanation for optimize density
1 parent e2f93e2 commit a77a34d

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

glassure/optimization.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,9 @@ def optimize_density(
171171
172172
:return:
173173
a tuple with four values:
174-
- the density, the standard error, the background scaling and the standard error for optimization_method='lsq'
174+
- the density, its error value, the background scaling and the error value
175+
whereby the error value is the standard error of the fit parameter for optimization_method ='lsq' and the
176+
sum of the squared residuals for optimization_method='nelder'.
175177
"""
176178

177179
if calculation_config.optimize is None and min_range is None and not method == "sq":

0 commit comments

Comments
 (0)