Skip to content

Commit 5710f07

Browse files
committed
chore: improve docs
1 parent b847438 commit 5710f07

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

src/post/optimizePeaks.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,11 @@ import { groupPeaks } from './groupPeaks';
1313
* @param {number} [options.factorLimits = 2] - times of width to use to optimize peaks
1414
* @param {object} [options.shape={}] - it's specify the kind of shape used to fitting.
1515
* @param {string} [options.shape.kind='gaussian'] - kind of shape; lorentzian, gaussian and pseudovoigt are supported.
16+
* @param {string} [options.shape.options={}] - options depending the kind of shape
1617
* @param {object} [options.optimization={}] - it's specify the kind and options of the algorithm use to optimize parameters.
1718
* @param {string} [options.optimization.kind='lm'] - kind of algorithm. By default it's levenberg-marquardt.
18-
* @param {number} [options.optimization.options.timeout=10] - maximum time running before break in seconds.
1919
* @param {object} [options.optimization.options={}] - options for the specific kind of algorithm.
20+
* @param {number} [options.optimization.options.timeout=10] - maximum time running before break in seconds.
2021
*/
2122

2223
export function optimizePeaks(data, peakList, options = {}) {

0 commit comments

Comments
 (0)