Improve moduledoc in Tmp.Worker

preciz · Jul 13, 2024 · 776d507 · 776d507
1 parent 8ec34fe
commit 776d507
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/lib/tmp/worker.ex b/lib/tmp/worker.ex
@@ -1,6 +1,11 @@
 defmodule Tmp.Worker do
   @moduledoc """
-  Executes the function given to `Tmp.dir/3` in a GenServer process
+  Executes the function given to `Tmp.dir/3` in a temporary GenServer process.
+  This module is not typically used directly.
+
+  This module is responsible for:
+  - Creating a temporary directory
+  - Ensuring the directory is monitored for cleanup
   """
 
   use GenServer, restart: :temporary