From 39f3b2c7ba29a8a80608d89cc9a1608651287d7a Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Fri, 31 Jan 2025 02:04:40 -1000 Subject: [PATCH] ;dev: doc --- hledger-lib/Hledger/Read/JournalReader.hs | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/hledger-lib/Hledger/Read/JournalReader.hs b/hledger-lib/Hledger/Read/JournalReader.hs index a08084edf..e69cf274a 100644 --- a/hledger-lib/Hledger/Read/JournalReader.hs +++ b/hledger-lib/Hledger/Read/JournalReader.hs @@ -282,10 +282,11 @@ directivep = (do ] ) "directive" --- | Parse an include directive. include's argument is an optionally --- file-format-prefixed file path or glob pattern. In the latter case, --- the prefix is applied to each matched path. Examples: --- foo.j, foo/bar.j, timedot:foo/2020*.md +-- | Parse an include directive, and the file(s) it refers to, possibly recursively. +-- include's argument is a file path or glob pattern, optionally with a file type prefix. +-- ~ at the start is expanded to the user's home directory. +-- Relative paths are relative to the current file. +-- Examples: foo.j, ../foo/bar.j, timedot:/foo/2020*, *.journal includedirectivep :: MonadIO m => ErroringJournalParser m () includedirectivep = do string "include"