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

README.md: fix "use with chai-as-promised" displayed incorrectly + make the "caveats" sections linkable #31

Merged
merged 1 commit into from Mar 12, 2018
Merged

README.md: fix "use with chai-as-promised" displayed incorrectly + make the "caveats" sections linkable #31

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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Expand Up @@ -45,7 +45,7 @@ The following built-in assertions are modified by this plugin to now use the fun

## Caveats

**Always terminate with a function**
### Always terminate with a function

These forms can also be mixed, but the chain must always be terminated in the function form or assertions up to that point in the chain will not execute.

Expand All @@ -54,7 +54,7 @@ expect(true).to.be.true.and.not.false();
expect(true).to.be.true().and.not.false();
```

**Chaining length/arguments**
### Chaining length/argument

This breaks both the `length` and `arguments` asserts when they are in the chain following any other assertion. To work around this limitation, do the `length` or `arguments` asserts first in the chain or just do multiple assertion statements.

Expand All @@ -66,7 +66,7 @@ myArray.should.exist();
myArray.should.have.length(3);
```

** use with chai-as-promised **
### use with chai-as-promised

If you're using chai-as-promised, you should `.use` chai-as-promised before dirty-chai:

Expand Down