Skip to content

Commit

Permalink
Reflect docstring of assert.sizeOf onto size method and README
Browse files Browse the repository at this point in the history
  • Loading branch information
astorije committed Mar 15, 2015
1 parent 9e5aa57 commit 6cd43ac
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 8 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,7 @@ expect(a).to.equal(b);

- **@param** *{ Number }* size

Asserts that the immutable collection's `size` property has the expected
value.
Asserts that the immutable collection has the expected size.

```js
expect(List.of(1, 2, 3)).to.have.size(3);
Expand All @@ -71,8 +70,7 @@ expect(List.of(1, 2, 3)).to.have.size.below(4);
expect(List.of(1, 2, 3)).to.have.size.within(2,4);
```

Similarly to `length`/`lengthOf`, `sizeOf` can be used as an alias of
`size`:
Similarly to `length`/`lengthOf`, `sizeOf` is an alias of `size`:

```js
expect(List.of(1, 2, 3)).to.have.sizeOf(3);
Expand Down
6 changes: 2 additions & 4 deletions chai-immutable.js
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,7 @@ module.exports = function (chai, utils) {
/**
* ### .size(value)
*
* Asserts that the immutable collection's `size` property has the expected
* value.
* Asserts that the immutable collection has the expected size.
*
* ```js
* expect(List.of(1, 2, 3)).to.have.size(3);
Expand All @@ -105,8 +104,7 @@ module.exports = function (chai, utils) {
* expect(List.of(1, 2, 3)).to.have.size.within(2,4);
* ```
*
* Similarly to `length`/`lengthOf`, `sizeOf` can be used as an alias of
* `size`:
* Similarly to `length`/`lengthOf`, `sizeOf` is an alias of `size`:
*
* ```js
* expect(List.of(1, 2, 3)).to.have.sizeOf(3);
Expand Down

0 comments on commit 6cd43ac

Please sign in to comment.