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

dev: lib: improve ReportSpec doc

Browse Source
This commit is contained in:
Simon Michael 2022-09-06 13:50:54 -10:00
parent 3e4f5f0417
commit bc810063a5
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
hledger-lib/Hledger/Reports/ReportOptions.hs
View File

@ -266,13 +266,14 @@ rawOptsToReportOpts d rawopts =
,layout_ = layoutopt rawopts ,layout_ = layoutopt rawopts
} }
-- | The result of successfully parsing a ReportOpts on a particular -- | A fully-determined set of report parameters
-- Day. Any ambiguous dates are completed and Queries are parsed, -- (report options with all partial values made total, eg the begin and end
-- ensuring that there are no regular expression errors. Values here -- dates are known, avoiding date/regex errors; plus the reporting date),
-- should be used in preference to re-deriving them from ReportOpts. -- and the query successfully calculated from them.
-- If you change the query_ in ReportOpts, you should call --
-- `reportOptsToSpec` to regenerate the ReportSpec with the new -- If you change the report options or date in one of these, you should
-- Query. -- use `reportOptsToSpec` to regenerate the whole thing, avoiding inconsistency.
--
data ReportSpec = ReportSpec data ReportSpec = ReportSpec
{ _rsReportOpts :: ReportOpts -- ^ The underlying ReportOpts used to generate this ReportSpec { _rsReportOpts :: ReportOpts -- ^ The underlying ReportOpts used to generate this ReportSpec
, _rsDay :: Day -- ^ The Day this ReportSpec is generated for , _rsDay :: Day -- ^ The Day this ReportSpec is generated for