Clear onPeak docs

rbtcollins · web-flow · commit 59f585082c8e · 2020-12-27T13:47:32.000+01:00
diff --git a/src/peakDetect.js b/src/peakDetect.js
@@ -160,9 +160,10 @@ class PeakDetect {
   }
 
   /**
-   *  onPeak accepts two arguments: a function to call when
-   *  a peak is detected. The value of the peak,
-   *  between 0.0 and 1.0, is passed to the callback.
+   *  onPeak accepts one or two arguments: a callback function to call when
+   *  a peak is detected and an optional callback parameter. The value of the
+   *  peak, between 0.0 and 1.0, is always passed to the callback first, with
+   *  the optional parameter provided second.
    *
    *  @method  onPeak
    *  @param  {Function} callback Name of a function that will

Original file line number	Diff line number	Diff line change
`@@ -160,9 +160,10 @@ class PeakDetect {`
`160`	`160`	`}`
`161`	`161`
`162`	`162`	`/**`
`163`		`- * onPeak accepts two arguments: a function to call when`
`164`		`- * a peak is detected. The value of the peak,`
`165`		`- * between 0.0 and 1.0, is passed to the callback.`
	`163`	`+ * onPeak accepts one or two arguments: a callback function to call when`
	`164`	`+ * a peak is detected and an optional callback parameter. The value of the`
	`165`	`+ * peak, between 0.0 and 1.0, is always passed to the callback first, with`
	`166`	`+ * the optional parameter provided second.`
`166`	`167`	`*`
`167`	`168`	`* @method onPeak`
`168`	`169`	`* @param {Function} callback Name of a function that will`