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

fix: added missing assert parameters in documentation #1023

Merged
merged 1 commit into from
Aug 9, 2017
Merged

fix: added missing assert parameters in documentation #1023

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
19 changes: 10 additions & 9 deletions chai.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6967,7 +6967,7 @@ module.exports = function (chai, util) {
}

/*!
* ### .ifError(object)
* ### .ifError(object, [message])
*
* Asserts if value is not a false value, and throws if it is a true value.
* This is added to allow for chai to be a drop-in replacement for Node's
Expand All @@ -6978,6 +6978,7 @@ module.exports = function (chai, util) {
*
* @name ifError
* @param {Object} object
* @param {String} message _optional_
* @namespace Assert
* @api public
*/
Expand All @@ -6989,7 +6990,7 @@ module.exports = function (chai, util) {
};

/**
* ### .isExtensible(object)
* ### .isExtensible(object, [message])
*
* Asserts that `object` is extensible (can have new properties added to it).
*
Expand All @@ -7008,7 +7009,7 @@ module.exports = function (chai, util) {
};

/**
* ### .isNotExtensible(object)
* ### .isNotExtensible(object, [message])
*
* Asserts that `object` is _not_ extensible.
*
Expand All @@ -7033,7 +7034,7 @@ module.exports = function (chai, util) {
};

/**
* ### .isSealed(object)
* ### .isSealed(object, [message])
*
* Asserts that `object` is sealed (cannot have new properties added to it
* and its existing properties cannot be removed).
Expand All @@ -7057,7 +7058,7 @@ module.exports = function (chai, util) {
};

/**
* ### .isNotSealed(object)
* ### .isNotSealed(object, [message])
*
* Asserts that `object` is _not_ sealed.
*
Expand All @@ -7076,7 +7077,7 @@ module.exports = function (chai, util) {
};

/**
* ### .isFrozen(object)
* ### .isFrozen(object, [message])
*
* Asserts that `object` is frozen (cannot have new properties added to it
* and its existing properties cannot be modified).
Expand All @@ -7097,7 +7098,7 @@ module.exports = function (chai, util) {
};

/**
* ### .isNotFrozen(object)
* ### .isNotFrozen(object, [message])
*
* Asserts that `object` is _not_ frozen.
*
Expand All @@ -7116,7 +7117,7 @@ module.exports = function (chai, util) {
};

/**
* ### .isEmpty(target)
* ### .isEmpty(target, [message])
*
* Asserts that the target does not contain any values.
* For arrays and strings, it checks the `length` property.
Expand All @@ -7142,7 +7143,7 @@ module.exports = function (chai, util) {
};

/**
* ### .isNotEmpty(target)
* ### .isNotEmpty(target, [message])
*
* Asserts that the target contains values.
* For arrays and strings, it checks the `length` property.
Expand Down