Add comments

ehmicky · Sep 5, 2021 · 59f73e4 · 59f73e4
1 parent 1886058
commit 59f73e4
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/src/report/reporters/boxplot/main.js b/src/report/reporters/boxplot/main.js
@@ -8,6 +8,8 @@ import { getPositions } from './position.js'
 import { getWidths } from './width.js'
 
 // Reporter showing boxplot of measures (min, q1, median, q3, max)
+// Configuration properties:
+//  - `mini` (default: false): hide `min`, `median` and `max` labels
 const reportTerminal = function (
   { combinations, screenWidth },
   { mini = false },

diff --git a/src/report/reporters/histogram/main.js b/src/report/reporters/histogram/main.js
@@ -11,6 +11,8 @@ import {
 import { getTitleBlock, getTitleBlockWidth } from './title.js'
 
 // Reporter showing distribution of measures with a histogram
+// Configuration properties:
+//  - `mini` (default: false): hide `min`, `median` and `max` labels
 const reportTerminal = function (
   { combinations, screenWidth },
   { mini = false },