Add docs for function style NOOP asserts

chaijs · Nov 4, 2014 · df2b2f4 · df2b2f4
1 parent 9142ce0
commit df2b2f4
Showing 1 changed file with 33 additions and 0 deletions.
diff --git a/lib/chai/core/assertions.js b/lib/chai/core/assertions.js
@@ -185,7 +185,12 @@ module.exports = function (chai, _) {
    *     expect(false).to.not.be.ok;
    *     expect(undefined).to.not.be.ok;
    *     expect(null).to.not.be.ok;
+   *     expect(null).to.not.be.ok;
+   *
+   * Can also be used in function form which will satiate certain linter errors.
    *
+   *     expect('everthing').to.be.ok();
+   *     
    * @name ok
    * @api public
    */
@@ -205,6 +210,10 @@ module.exports = function (chai, _) {
    *     expect(true).to.be.true;
    *     expect(1).to.not.be.true;
    *
+   * Can also be used in function form which will satiate certain linter errors.
+   *
+   *     expect(true).to.be.true();
+   *
    * @name true
    * @api public
    */
@@ -226,6 +235,10 @@ module.exports = function (chai, _) {
    *     expect(false).to.be.false;
    *     expect(0).to.not.be.false;
    *
+   * Can also be used in function form which will satiate certain linter errors.
+   *
+   *     expect(false).to.be.false();
+   *
    * @name false
    * @api public
    */
@@ -247,6 +260,10 @@ module.exports = function (chai, _) {
    *     expect(null).to.be.null;
    *     expect(undefined).not.to.be.null;
    *
+   * Can also be used in function form which will satiate certain linter errors.
+   *
+   *     expect(null).to.be.null();
+   *
    * @name null
    * @api public
    */
@@ -267,6 +284,10 @@ module.exports = function (chai, _) {
    *     expect(undefined).to.be.undefined;
    *     expect(null).to.not.be.undefined;
    *
+   * Can also be used in function form which will satiate certain linter errors.
+   *
+   *     expect(undefined).to.be.undefined();
+   *
    * @name undefined
    * @api public
    */
@@ -292,6 +313,10 @@ module.exports = function (chai, _) {
    *     expect(bar).to.not.exist;
    *     expect(baz).to.not.exist;
    *
+   * Can also be used in function form which will satiate certain linter errors.
+   *
+   *     expect('everthing').to.be.ok();
+   *
    * @name exist
    * @api public
    */
@@ -316,6 +341,10 @@ module.exports = function (chai, _) {
    *     expect('').to.be.empty;
    *     expect({}).to.be.empty;
    *
+   * Can also be used in function form which will satiate certain linter errors.
+   *
+   *     expect('everthing').to.be.ok();
+   *
    * @name empty
    * @api public
    */
@@ -346,6 +375,10 @@ module.exports = function (chai, _) {
    *       expect(arguments).to.be.arguments;
    *     }
    *
+   * Can also be used in function form which will satiate certain linter errors.
+   *
+   *     expect('everthing').to.be.ok();
+   *
    * @name arguments
    * @alias Arguments
    * @api public