Merge pull request #382 from astorije/patch-2

Add missing docstring for showDiff argument of assert
chaijs · Mar 1, 2015 · 062d731 · 062d731
2 parents 1ce171f + 592be87
commit 062d731
Showing 1 changed file with 2 additions and 1 deletion.
diff --git 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
    */