slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

;dev:Hledger.Utils.Debug: haddockify some comments so they show in hover

Browse Source
This commit is contained in:
Simon Michael 2023-12-23 07:32:00 -10:00
parent 4651f2e0bb
commit 4b7e7f77bd
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
hledger-lib/Hledger/Utils/Debug.hs
View File

@ -329,27 +329,27 @@ ptraceLogAtIO level label a =
then return () then return ()
else traceLogIO (labelledPretty False label a) else traceLogIO (labelledPretty False label a)
-- Trace or log a string depending on shouldLog, -- | Trace or log a string depending on shouldLog,
-- before returning the second argument. -- before returning the second argument.
traceOrLog :: String -> a -> a traceOrLog :: String -> a -> a
traceOrLog = if shouldLog then trace else traceLog traceOrLog = if shouldLog then trace else traceLog
-- Trace or log a string depending on shouldLog, -- | Trace or log a string depending on shouldLog,
-- when global debug level is at or above the specified level, -- when global debug level is at or above the specified level,
-- before returning the second argument. -- before returning the second argument.
traceOrLogAt :: Int -> String -> a -> a traceOrLogAt :: Int -> String -> a -> a
traceOrLogAt = if shouldLog then traceLogAt else traceAt traceOrLogAt = if shouldLog then traceLogAt else traceAt
-- Pretty-trace or log depending on shouldLog, when global debug level -- | Pretty-trace or log depending on shouldLog, when global debug level
-- is at or above the specified level. -- is at or above the specified level.
ptraceOrLogAt :: Show a => Int -> String -> a -> a ptraceOrLogAt :: Show a => Int -> String -> a -> a
ptraceOrLogAt = if shouldLog then ptraceLogAt else ptraceAt ptraceOrLogAt = if shouldLog then ptraceLogAt else ptraceAt
-- Like ptraceOrLogAt, but convenient in IO. -- | Like ptraceOrLogAt, but convenient in IO.
ptraceOrLogAtIO :: (MonadIO m, Show a) => Int -> String -> a -> m () ptraceOrLogAtIO :: (MonadIO m, Show a) => Int -> String -> a -> m ()
ptraceOrLogAtIO = if shouldLog then ptraceLogAtIO else ptraceAtIO ptraceOrLogAtIO = if shouldLog then ptraceLogAtIO else ptraceAtIO
-- Trace or log, with a show function, depending on shouldLog. -- | Trace or log, with a show function, depending on shouldLog.
traceOrLogAtWith :: Int -> (a -> String) -> a -> a traceOrLogAtWith :: Int -> (a -> String) -> a -> a
traceOrLogAtWith = if shouldLog then traceLogAtWith else traceAtWith traceOrLogAtWith = if shouldLog then traceLogAtWith else traceAtWith