docs: correct .ok description

This commit is contained in:
Aleksey Shvayka 2017-09-11 02:26:04 +03:00 committed by GitHub
parent dbeae08fe5
commit 37dc80ddd0

View file

@ -589,9 +589,9 @@ module.exports = function (chai, _) {
/**
* ### .ok
*
* Asserts that the target is loosely (`==`) equal to `true`. However, it's
* often best to assert that the target is strictly (`===`) or deeply equal to
* its expected value.
* Asserts that the target is a truthy value (considered `true` in boolean context).
* However, it's often best to assert that the target is strictly (`===`) or
* deeply equal to its expected value.
*
* expect(1).to.equal(1); // Recommended
* expect(1).to.be.ok; // Not recommended