add module doc

wyeworks · Aug 22, 2024 · 39adb82 · 39adb82
1 parent 729c952
commit 39adb82
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/lib/boom_notifier/api.ex b/lib/boom_notifier/api.ex
@@ -1,4 +1,9 @@
 defmodule BoomNotifier.Api do
+  @moduledoc """
+  BoomNotifier Entrypoint API
+
+  Define functions required by BoomNotifier module when used on a plug app.
+  """
   require Logger
 
   alias BoomNotifier.ErrorInfo

diff --git a/test/support/case.ex b/test/support/case.ex
@@ -1,4 +1,6 @@
 defmodule BoomNotifier.Case do
+  @moduledoc false
+
   use ExUnit.CaseTemplate
 
   setup_all do