aboutsummaryrefslogtreecommitdiff
path: root/hsm-core/Hsm/Core/Log.hs
diff options
context:
space:
mode:
authorPaul Oliver <contact@pauloliver.dev>2025-01-27 14:51:28 +0000
committerPaul Oliver <contact@pauloliver.dev>2025-01-29 04:12:57 +0000
commit9d2f95bb58f856aaf9142426e90e5783c98af8f1 (patch)
tree9453d5cbed1ae2165e6c8f0824ded00d2372e7bd /hsm-core/Hsm/Core/Log.hs
parent9310ba7e17f97c4570dce33552b3605155ca5c0c (diff)
Makes doc-comments cleaner/more elegant
Diffstat (limited to 'hsm-core/Hsm/Core/Log.hs')
-rw-r--r--hsm-core/Hsm/Core/Log.hs5
1 files changed, 3 insertions, 2 deletions
diff --git a/hsm-core/Hsm/Core/Log.hs b/hsm-core/Hsm/Core/Log.hs
index 6930e90..c097e0f 100644
--- a/hsm-core/Hsm/Core/Log.hs
+++ b/hsm-core/Hsm/Core/Log.hs
@@ -11,8 +11,9 @@ import Effectful (Eff, (:>))
import Effectful.Dispatch.Static (unsafeEff_)
import Effectful.Log qualified as L
--- Helper function allows logging within IO, Useful during `resourcet`
--- allocation and release operations.
+-- This helper function enables logging within the IO monad, which is
+-- particularly useful during resource allocation and release operations with
+-- `resourcet`.
withLogIO :: L.Log :> es => Eff es (L.LogLevel -> Text -> IO ())
withLogIO = do
logIO <- L.getLoggerIO