From 3f050d45a95f1a218ebbd9fd0a948c1040f0347d Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Thu, 24 Aug 2023 16:20:30 +0100 Subject: [PATCH] dev: improve showMixedAmountLinesB doc --- hledger-lib/Hledger/Data/Amount.hs | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/hledger-lib/Hledger/Data/Amount.hs b/hledger-lib/Hledger/Data/Amount.hs index 46e523143..c1aa2c004 100644 --- a/hledger-lib/Hledger/Data/Amount.hs +++ b/hledger-lib/Hledger/Data/Amount.hs @@ -855,10 +855,9 @@ showMixedAmountB opts ma width = headDef 0 $ map wbWidth ls sep = WideBuilder (TB.singleton '\n') 0 --- | Helper for showMixedAmountB to show a list of Amounts on multiple lines. This returns --- the list of WideBuilders: one for each Amount, and padded/elided to the appropriate --- width. This does not honour displayOneLine: all amounts will be displayed as if --- displayOneLine were False. +-- | Helper for showMixedAmountB (and postingAsLines, ...) to show a list of Amounts on multiple lines. +-- This returns the list of WideBuilders: one for each Amount, and padded/elided to the appropriate width. +-- This does not honour displayOneLine; all amounts will be displayed as if displayOneLine were False. showMixedAmountLinesB :: AmountDisplayOpts -> MixedAmount -> [WideBuilder] showMixedAmountLinesB opts@AmountDisplayOpts{displayMaxWidth=mmax,displayMinWidth=mmin} ma = map (adBuilder . pad) elided