Skip to content

Commit

Permalink
passim: refine behavior description for edge case
Browse files Browse the repository at this point in the history
The implemented behavior is to fail when a test fails, and otherwise
pass.  The documented behavior could have been interpreted to specify
failure when no tests were provided, which was not the intent.

Add a section describing changes so people can let go of concerns about
why a trivial package like this keeps getting updated.
  • Loading branch information
pabigot committed Mar 17, 2018
1 parent dc70ed8 commit 1e5c08e
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 3 deletions.
24 changes: 22 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,29 @@ describe('suite', function() {
`test` method must accept `error.message`. If not provided the value
of `error.message` is not tested.

Returns `true` if the provided `constructor` and `msgCheck`
verifications succeed, `false` otherwise.
Returns `false` if a provided `constructor` or `msgCheck` verification
fails, `true` otherwise.

## Change Log

All changes since 1.0.0 relate to package documentation.

### [1.0.2] - 2018-03-17

* Correct documentation of behavior in the case where no verifications
are provided.

### [1.0.1] - 2018-03-13

* Add script to `package.json` so coveralls updates are performed.

### 1.0.0 - 2018-03-13

* Initial release

## License

* [MIT License](https://opensource.org/licenses/MIT)

[1.0.2]: https://github.com/pabigot/test-error/compare/v1.0.1...v1.0.2
[1.0.1]: https://github.com/pabigot/test-error/compare/v1.0.0...v1.0.1
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "test-error",
"version": "1.0.1",
"version": "1.0.2",
"description": "Function to check the type and message content of a Node.js Error",
"keywords": [
"assert",
Expand Down

0 comments on commit 1e5c08e

Please sign in to comment.