From 592be870e813fcb910629b91e341163e7396d5b4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=A9mie=20Astori?= Date: Sat, 28 Feb 2015 18:02:38 -0500 Subject: [PATCH] Add missing docstring for showDiff argument of assert --- lib/chai/assertion.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lib/chai/assertion.js b/lib/chai/assertion.js index a3405a832..24c9fc16d 100644 --- a/lib/chai/assertion.js +++ b/lib/chai/assertion.js @@ -88,10 +88,11 @@ module.exports = function (_chai, util) { * * @name assert * @param {Philosophical} expression to be tested - * @param {String or Function} message or function that returns message to display if fails + * @param {String or Function} message or function that returns message to display if expression fails * @param {String or Function} negatedMessage or function that returns negatedMessage to display if negated expression fails * @param {Mixed} expected value (remember to check for negation) * @param {Mixed} actual (optional) will default to `this.obj` + * @param {Boolean} showDiff (optional) when set to `true`, assert will display a diff in addition to the message if expression fails * @api private */