From 5fa06453f15ce786f871c4f8fe419cfd49e2acf0 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Fri, 28 Aug 2015 08:04:54 -0700 Subject: [PATCH] lib: note depth's filtering and display control uses --- hledger-lib/Hledger/Query.hs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/hledger-lib/Hledger/Query.hs b/hledger-lib/Hledger/Query.hs index 9699199c3..658aa6cf3 100644 --- a/hledger-lib/Hledger/Query.hs +++ b/hledger-lib/Hledger/Query.hs @@ -78,7 +78,9 @@ data Query = Any -- ^ always match | Sym Regexp -- ^ match if the entire commodity symbol is matched by this regexp | Empty Bool -- ^ if true, show zero-amount postings/accounts which are usually not shown -- more of a query option than a query criteria ? - | Depth Int -- ^ match if account depth is less than or equal to this value + | Depth Int -- ^ match if account depth is less than or equal to this value. + -- Depth is sometimes used like a query (for filtering report data) + -- and sometimes like a query option (for controlling display) | Tag Regexp (Maybe Regexp) -- ^ match if a tag's name, and optionally its value, is matched by these respective regexps -- matching the regexp if provided, exists deriving (Eq,Data,Typeable)