From d4457931efe335f7ebdef14792d07471f8cd07c5 Mon Sep 17 00:00:00 2001
From: Simon Michael <simon@joyful.com>
Date: Wed, 5 Jul 2017 08:08:20 +0100
Subject: [PATCH] cli: document journalApplyValue

---
 hledger/Hledger/Cli/Utils.hs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/hledger/Hledger/Cli/Utils.hs b/hledger/Hledger/Cli/Utils.hs
index cb9e41dd8..8ab2af72c 100644
--- a/hledger/Hledger/Cli/Utils.hs
+++ b/hledger/Hledger/Cli/Utils.hs
@@ -126,6 +126,10 @@ anonymise j
   where
     anon = T.pack . flip showHex "" . (fromIntegral :: Int -> Word32) . hash
 
+-- XXX as of since 2017/4 this is used instead of 
+-- balanceReportValue/multiBalanceReportValue (mostly; not yet hledger-ui)
+-- | If -V/--value was requested, convert all journal amounts to their market value
+-- as of the report end date. Cf http://hledger.org/manual.html#market-value
 journalApplyValue :: ReportOpts -> Journal -> IO Journal
 journalApplyValue ropts j = do
     mvaluedate <- reportEndDate j ropts