lib: note aquantity zero with AUTO amounts

2019-01-04 19:03:03 +00:00 · 2019-01-04 19:03:03 +00:00 · cd1455e9ea
commit cd1455e9ea
parent 5908414d77
1 changed files with 2 additions and 2 deletions
--- a/hledger-lib/Hledger/Data/Types.hs
+++ b/hledger-lib/Hledger/Data/Types.hs
@ -201,8 +201,8 @@ data Commodity = Commodity {
 instance NFData Commodity

 data Amount = Amount {
-      acommodity  :: CommoditySymbol,
-      aquantity   :: Quantity,
+      acommodity  :: CommoditySymbol,   -- commodity symbol, or special value "AUTO"
+      aquantity   :: Quantity,          -- numeric quantity, or zero in case of "AUTO"
      aismultiplier :: Bool,            -- ^ kludge: a flag marking this amount and posting as a multiplier
                                        --   in a TMPostingRule. In a regular Posting, should always be false.
      astyle      :: AmountStyle,