aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorLouis Pilfold <louis@lpil.uk>2020-04-26 13:04:54 +0100
committerLouis Pilfold <louis@lpil.uk>2020-04-26 13:04:54 +0100
commita2ff46bbc05ac6cbebf2ab5e88daef18c2b9ff8b (patch)
treef8d16252f40f4dafd616da21c31a4cb643e95155 /src
parentae5b58fd003b1f301b2c8488fa820cb86bf6e51e (diff)
downloadgleam_stdlib-a2ff46bbc05ac6cbebf2ab5e88daef18c2b9ff8b.tar.gz
gleam_stdlib-a2ff46bbc05ac6cbebf2ab5e88daef18c2b9ff8b.zip
Module documentation for gleam/should
Diffstat (limited to 'src')
-rw-r--r--src/gleam/should.gleam6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/gleam/should.gleam b/src/gleam/should.gleam
index 0fbebeb..b0a1dc5 100644
--- a/src/gleam/should.gleam
+++ b/src/gleam/should.gleam
@@ -1,3 +1,9 @@
+//// A module for testing your Gleam code. The functions found here are
+//// compatible with the Erlang eunit test framework.
+////
+//// More information on running eunit can be found in [the rebar3
+//// documentation](https://www.rebar3.org/docs/running-tests).
+
// TODO: Move this module into another package so it can be used as a
// dep only in test.