Merge pull request #397 from astorije/astorije/assert-plugin-api

Add missing parameter showDiff and make docstring "documentationable"
chaijs · May 3, 2015 · 73f5d99 · 73f5d99
2 parents 08819da + 15b9c70
commit 73f5d99
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/chai.js b/chai.js
@@ -845,8 +845,8 @@ module.exports = function (_chai, util) {
     util.overwriteChainableMethod(this.prototype, name, fn, chainingBehavior);
   };
 
-  /*!
-   * ### .assert(expression, message, negateMessage, expected, actual)
+  /**
+   * ### .assert(expression, message, negateMessage, expected, actual, showDiff)
    *
    * Executes an expression and check expectations. Throws AssertionError for reporting if test doesn't pass.
    *

diff --git a/lib/chai/assertion.js b/lib/chai/assertion.js
@@ -81,8 +81,8 @@ module.exports = function (_chai, util) {
     util.overwriteChainableMethod(this.prototype, name, fn, chainingBehavior);
   };
 
-  /*!
-   * ### .assert(expression, message, negateMessage, expected, actual)
+  /**
+   * ### .assert(expression, message, negateMessage, expected, actual, showDiff)
    *
    * Executes an expression and check expectations. Throws AssertionError for reporting if test doesn't pass.
    *