From 6cd43ac034122ae69ccc71b4891845847a7b4f56 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=A9mie=20Astori?= Date: Sat, 14 Mar 2015 20:08:21 -0400 Subject: [PATCH] Reflect docstring of assert.sizeOf onto size method and README --- README.md | 6 ++---- chai-immutable.js | 6 ++---- 2 files changed, 4 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index a6bab01..f31b40e 100644 --- a/README.md +++ b/README.md @@ -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); @@ -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); diff --git a/chai-immutable.js b/chai-immutable.js index 313d5d0..8a20b6a 100644 --- a/chai-immutable.js +++ b/chai-immutable.js @@ -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); @@ -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);