aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-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.