docs: improve xBoxPlot jsdoc (#261)

mljs · Oct 1, 2024 · ee58725 · ee58725
1 parent 985caee
commit ee58725
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/src/x/xBoxPlot.ts b/src/x/xBoxPlot.ts
@@ -20,6 +20,7 @@ export interface XBoxPlot {
  * Calculating the box plot of the array
  * @param array - data
  * @param options
+ * @returns - q1, median, q3, min, max
  */
 export function xBoxPlot(
   array: NumberArray,

diff --git a/src/x/xBoxPlotWithOutliers.ts b/src/x/xBoxPlotWithOutliers.ts
@@ -12,9 +12,11 @@ export interface XBoxPlotWithOutliers {
 }
 
 /**
- * Calculating the box plot of the array
+ * Calculating the box plot of the array with outliers
+ * Values are outliers if they are below Q1 - 1.5 * IQR or above Q3 + 1.5 * IQR
  * @param array - data
  * @param options
+ * @returns - q1, median, q3, min, max, outliers
  */
 export function xBoxPlotWithOutliers(
   array: NumberArray,