Mirrors/chai
2
0
Fork 0
mirror of https://github.com/chaijs/chai synced 2024-11-14 15:57:10 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #1047 from chaijs/assert-description

Browse source 
docs: correct `.ok` description
This commit is contained in:
Jérémie Astori 2017-09-10 23:49:59 -04:00 committed by GitHub
commit 9489ecee82
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
lib/chai/core/assertions.js
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