From d47107ab7ae4a32a4a99b0b0eb7e7795a7a8777f Mon Sep 17 00:00:00 2001
From: Simon Michael <simon@joyful.com>
Date: Thu, 6 Mar 2025 05:39:23 -1000
Subject: [PATCH] ;dev:readJournal: doc

---
 hledger-lib/Hledger/Read.hs | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/hledger-lib/Hledger/Read.hs b/hledger-lib/Hledger/Read.hs
index 4390d421e..476793a7d 100644
--- a/hledger-lib/Hledger/Read.hs
+++ b/hledger-lib/Hledger/Read.hs
@@ -218,7 +218,11 @@ type PrefixedFilePath = FilePath
 -- - a file extension in @mfile@
 --
 -- If none of these is available, or if the reader name is unrecognised,
--- we use the journal reader (for predictability).
+-- the journal reader is used.
+--
+-- If a file path is not provided, "-" is assumed (and may appear in error messages,
+-- `files` output etc, where it will be a slight lie: it will mean "not from a file",
+-- not necessarily "from standard input".
 --
 readJournal :: InputOpts -> Maybe FilePath -> Handle -> ExceptT String IO Journal
 readJournal iopts@InputOpts{strict_, _defer} mpath hdl = do