embedded files comment

[ci skip]
2019-01-26 16:39:36 -08:00 · 2019-01-26 16:39:36 -08:00 · d1411fbd8d
commit d1411fbd8d
parent 817497f30b
1 changed files with 3 additions and 0 deletions
--- a/hledger/Hledger/Cli/DocFiles.hs
+++ b/hledger/Hledger/Cli/DocFiles.hs
@ -33,6 +33,9 @@ import Hledger.Utils (first3, second3, third3, embedFileRelative)

 type Topic = String

+-- | These are all the main hledger manuals, in man, txt, and info formats.
+-- Only files under the current package directory can be embedded,
+-- so most of these are symlinked here from the other package directories.
 docFiles :: [(Topic, (ByteString, ByteString, ByteString))]
 docFiles = [
   ("hledger",