From 1f891a4145bbd00a9e0e2108f1f267348ab0526d Mon Sep 17 00:00:00 2001 From: Stephen Morgan Date: Tue, 29 Dec 2020 10:15:40 +1100 Subject: [PATCH] doc: Fix some outdated documentation. --- hledger-lib/Hledger/Reports/PostingsReport.hs | 4 ++-- hledger-lib/Hledger/Reports/TransactionsReport.hs | 6 ++---- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/hledger-lib/Hledger/Reports/PostingsReport.hs b/hledger-lib/Hledger/Reports/PostingsReport.hs index b85f54528..26ec4d5a3 100644 --- a/hledger-lib/Hledger/Reports/PostingsReport.hs +++ b/hledger-lib/Hledger/Reports/PostingsReport.hs @@ -34,8 +34,8 @@ import Hledger.Utils import Hledger.Reports.ReportOptions --- | A postings report is a list of postings with a running total, a label --- for the total field, and a little extra transaction info to help with rendering. +-- | A postings report is a list of postings with a running total, and a little extra +-- transaction info to help with rendering. -- This is used eg for the register command. type PostingsReport = [PostingsReportItem] -- line items, one per posting type PostingsReportItem = (Maybe Day -- The posting date, if this is the first posting in a diff --git a/hledger-lib/Hledger/Reports/TransactionsReport.hs b/hledger-lib/Hledger/Reports/TransactionsReport.hs index b3da66179..a6cd1a37a 100644 --- a/hledger-lib/Hledger/Reports/TransactionsReport.hs +++ b/hledger-lib/Hledger/Reports/TransactionsReport.hs @@ -35,10 +35,8 @@ import Hledger.Utils -- | A transactions report includes a list of transactions touching multiple accounts -- (posting-filtered and unfiltered variants), a running balance, and some --- other information helpful for rendering a register view (a flag --- indicating multiple other accounts and a display string describing --- them) with or without a notion of current account(s). --- Two kinds of report use this data structure, see transactionsReport +-- other information helpful for rendering a register view with or without a notion +-- of current account(s). Two kinds of report use this data structure, see transactionsReport -- and accountTransactionsReport below for details. type TransactionsReport = [TransactionsReportItem] -- line items, one per transaction type TransactionsReportItem = (Transaction -- the original journal transaction, unmodified