codedownio/sandwich
1
1
Fork 0
mirror of https://github.com/codedownio/sandwich.git synced 2024-09-21 00:38:27 +03:00
Code Issues Projects Releases Wiki Activity

Remove a broken link

Browse Source
This commit is contained in:
Tom McLaughlin 2021-05-22 01:10:05 -06:00
parent 818099ea2a
commit 3913ed2f8f
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
sandwich-site/docs/intro.md
View File

@ -43,7 +43,7 @@ main = runSandwichWithCommandLineArgs defaultOptions basic
The tests above assert things using expectation functions like `shouldBe`. There are a variety of these in [Test.Sandwich.Expectations](http://hackage.haskell.org/package/sandwich/docs/Test-Sandwich-Expectations.html) such as `shouldNotBe`, `shouldContain`, etc., and they are similar to other test frameworks.
These functions simply throw an exception of type [FailureReason](http://hackage.haskell.org/package/sandwich/docs/Test-Sandwich-Misc.html#t:FailureReason) which the Sandwich machinery catches and displays. Don't worry, you can throw other exceptions too. You can even write instances for your [custom exception types](extensions/advanced#formatting-custom-exceptions) so that they display nicely in Sandwich [formatters](formatters/tui).
These functions simply throw an exception of type [FailureReason](http://hackage.haskell.org/package/sandwich/docs/Test-Sandwich-Misc.html#t:FailureReason) which the Sandwich machinery catches and displays. Don't worry, you can throw other exceptions too. You can even write instances for your [custom exception types](#) so that they display nicely in Sandwich [formatters](formatters/tui).
To fail a test with a string message, just call [expectationFailure](http://hackage.haskell.org/package/sandwich/docs/Test-Sandwich-Expectations.html#v:expectationFailure). You can also mark a test as "pending" by calling the [pending](http://hackage.haskell.org/package/sandwich/docs/Test-Sandwich-Expectations.html#v:pending) function anywhere in the test, or by changing `it` to `xit`.