From 9d2f95bb58f856aaf9142426e90e5783c98af8f1 Mon Sep 17 00:00:00 2001 From: Paul Oliver Date: Mon, 27 Jan 2025 14:51:28 +0000 Subject: Makes doc-comments cleaner/more elegant --- hsm-core/Hsm/Core/Log.hs | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'hsm-core/Hsm/Core/Log.hs') 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 -- cgit v1.2.1