From 1539b258b9aa0d4639d2f7d7e8e9c9725f4f7279 Mon Sep 17 00:00:00 2001
From: Simon Michael <simon@joyful.com>
Date: Sat, 19 Nov 2016 08:57:03 -0800
Subject: [PATCH] lib: more Hledger.Read cleanup

---
 hledger-lib/Hledger/Read.hs | 23 ++++++-----------------
 1 file changed, 6 insertions(+), 17 deletions(-)

diff --git a/hledger-lib/Hledger/Read.hs b/hledger-lib/Hledger/Read.hs
index a560c47b1..eaf9981f5 100644
--- a/hledger-lib/Hledger/Read.hs
+++ b/hledger-lib/Hledger/Read.hs
@@ -4,18 +4,6 @@ This is the entry point to hledger's reading system, which can read
 Journals from various data formats. Use this module if you want to parse
 journal data or read journal files. Generally it should not be necessary
 to import modules below this one.
-
-Here's how most of these functions fit together:
-
-@
-readJournalFiles
- readJournalFile
-  requireJournalFileExists
-  readJournal
-   findReader
-   tryReaders
-@
-
 -}
 
 {-# LANGUAGE ScopedTypeVariables, OverloadedStrings #-}
@@ -127,11 +115,12 @@ readJournalFiles mformat mrulesfile assrt fs = do
 
 -- | @readJournalFile mformat mrulesfile assrt f@
 --
--- Read a Journal from this file (or stdin if the filename is -) or give
--- an error message, using the specified data format or trying all known
--- formats. A CSV conversion rules file may be specified for better
--- conversion of that format. Also there is a flag specifying whether
--- to check or ignore balance assertions in the journal.
+-- Read a Journal from this file (or stdin if the file path is -).
+-- Assume the specified data format, or a format identified from the file path,
+-- or try all readers.
+-- A CSV conversion rules file may be specified for better conversion of CSV.
+-- Also optionally check any balance assertions in the journal.
+-- If parsing or balance assertions fail, return an error message instead.
 readJournalFile :: Maybe StorageFormat -> Maybe FilePath -> Bool -> FilePath -> IO (Either String Journal)
 readJournalFile mformat mrulesfile assrt f = do
   requireJournalFileExists f