Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

JSDoc blocks aligned with corresponding functions #495

Merged
merged 1 commit into from
Jul 20, 2015
Merged

JSDoc blocks aligned with corresponding functions #495

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
38 changes: 19 additions & 19 deletions lib/chai/interface/assert.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand All @@ -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
*/
Expand All @@ -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
*/
Expand Down