Added example for custom expectation-fail message in docs#486
Merged
Added example for custom expectation-fail message in docs#486
Conversation
jgebal
requested changes
Sep 29, 2017
Member
jgebal
left a comment
There was a problem hiding this comment.
Hi @pesse ,
Can you update the Concepts section?
The syntax should include 'message' as an optional parameter.
I think that the whole section you are proposing to add, could go as sup-section under the Concepts.
Please change the error to failure.
Thanks for the contribution. It's a nice addition to the documentation.
| ``` | ||
| Since NULL is neither *true* nor *not true*, both expectations will report failure. | ||
|
|
||
| # Provide a custom error message |
Member
There was a problem hiding this comment.
To be consistent with the rest of document please change that to: Adding custom failure message
| # Provide a custom error message | ||
| Expectations allow you to provide a custom error message as second argument: | ||
| ````sql | ||
| ut.expect( a_actual {data-type}, 'custom error message if expectation fails' ).to_{matcher}; |
Member
There was a problem hiding this comment.
Can you replace the 'error message' with 'failure message' or just 'custom message'.
There is a difference between error and failure as we define errored test as a test procedure that raised an unhandled exception.
replaced "error" with "failure", moved section as sub-section of Concepts, reworked Concepts slightly
jgebal
approved these changes
Sep 29, 2017
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #485