From 1a47ff1a5ffd9ca162370fe99a4973f616c048cc Mon Sep 17 00:00:00 2001 From: Aaron Sofaly Date: Sun, 22 Jan 2017 14:22:30 -0700 Subject: [PATCH] added headline for inspect util --- lib/chai/utils/inspect.js | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/lib/chai/utils/inspect.js b/lib/chai/utils/inspect.js index edbc55c..af2cdb1 100644 --- a/lib/chai/utils/inspect.js +++ b/lib/chai/utils/inspect.js @@ -9,12 +9,14 @@ var config = require('../config'); module.exports = inspect; /** + * ### .inspect(obj, [showHidden], [depth], [colors]) + * * Echoes the value of a value. Tries to print the value out * in the best way possible given the different types. * * @param {Object} obj The object to print out. * @param {Boolean} showHidden Flag that shows hidden (not enumerable) - * properties of objects. + * properties of objects. Default is false. * @param {Number} depth Depth in which to descend in object. Default is 2. * @param {Boolean} colors Flag to turn on ANSI escape codes to color the * output. Default is false (no coloring).