From 776d507960cf2881da97088b59564181423757fc Mon Sep 17 00:00:00 2001 From: preciz Date: Sat, 13 Jul 2024 20:07:33 +0200 Subject: [PATCH] Improve moduledoc in Tmp.Worker --- lib/tmp/worker.ex | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/lib/tmp/worker.ex b/lib/tmp/worker.ex index 56fe351..63acf57 100644 --- 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