Merge pull request #495 from cezarykluczynski/assertions-docblocks-re…

…order JSDoc blocks aligned with corresponding functions
chaijs · Jul 20, 2015 · bad5fa7 · bad5fa7
2 parents 3bd4d49 + b9730e0
commit bad5fa7
Showing 1 changed file with 19 additions and 19 deletions.
diff --git a/lib/chai/interface/assert.js b/lib/chai/interface/assert.js
@@ -225,16 +225,16 @@ module.exports = function (chai, util) {
     new Assertion(act, msg).to.not.eql(exp);
   };
 
-  /**
-   * ### .isTrue(value, [message])
+   /**
+   * ### .isAbove(valueToCheck, valueToBeAbove, [message])
    *
-   * Asserts that `value` is true.
+   * Asserts `valueToCheck` is strictly greater than (>) `valueToBeAbove`
    *
-   *     var teaServed = true;
-   *     assert.isTrue(teaServed, 'the tea has been served');
+   *     assert.isAbove(5, 2, '5 is strictly greater than 2');
    *
-   * @name isTrue
-   * @param {Mixed} value
+   * @name isAbove
+   * @param {Mixed} valueToCheck
+   * @param {Mixed} valueToBeAbove
    * @param {String} message
    * @api public
    */
@@ -244,15 +244,15 @@ module.exports = function (chai, util) {
   };
 
    /**
-   * ### .isAbove(valueToCheck, valueToBeAbove, [message])
+   * ### .isBelow(valueToCheck, valueToBeBelow, [message])
    *
-   * Asserts `valueToCheck` is strictly greater than (>) `valueToBeAbove`
+   * Asserts `valueToCheck` is strictly less than (<) `valueToBeBelow`
    *
-   *     assert.isAbove(5, 2, '5 is strictly greater than 2');
+   *     assert.isBelow(3, 6, '3 is strictly less than 6');
    *
-   * @name isAbove
+   * @name isBelow
    * @param {Mixed} valueToCheck
-   * @param {Mixed} valueToBeAbove
+   * @param {Mixed} valueToBeBelow
    * @param {String} message
    * @api public
    */
@@ -261,16 +261,16 @@ module.exports = function (chai, util) {
     new Assertion(val, msg).to.be.below(blw);
   };
 
-   /**
-   * ### .isBelow(valueToCheck, valueToBeBelow, [message])
+  /**
+   * ### .isTrue(value, [message])
    *
-   * Asserts `valueToCheck` is strictly less than (<) `valueToBeBelow`
+   * Asserts that `value` is true.
    *
-   *     assert.isBelow(3, 6, '3 is strictly less than 6');
+   *     var teaServed = true;
+   *     assert.isTrue(teaServed, 'the tea has been served');
    *
-   * @name isBelow
-   * @param {Mixed} valueToCheck
-   * @param {Mixed} valueToBeBelow
+   * @name isTrue
+   * @param {Mixed} value
    * @param {String} message
    * @api public
    */