Inconsistency between documentation and code: * comments missing from csv rules

[sprig]

Hello and thanks for creating and maintaining hledger!

I just spent some time trying to figure out what lines starting with * mean, in a rules file (that I wrote a while ago, moreover). Suspected and eventually confirmed to be comments by the below referenced line, nowhere in the docs is * mentioned as an allowable comment character, as far as I can tell, including in specification laid out in the same file. I did eventually find https://hledger.org/1.28/hledger.html#comments which allows for * comments in the journal, which I presume is why I tried the same in the rules file.

Definition:

hledger/hledger-lib/Hledger/Read/CsvReader.hs

Line 444 in 68a9122

commentcharp = oneOf (";#*" :: [Char])

Spec:

hledger/hledger-lib/Hledger/Read/CsvReader.hs

Line 403 in 68a9122

COMMENT-CHAR: # | ;

Documentation:
First paragraph of https://hledger.org/1.28/hledger.html#csv-rules

[simonmichael]

Thanks! I have clarified the support for * comment lines in CSV rules, timeclock and timedot formats.

[simonmichael]

Though FWIW, supporting * comment lines seems no longer valuable. Nowadays, Emacs users like myself probably prefer using ledger-mode plus outshine-mode to fold journals, rather than switching to org mode and losing the benefits of ledger-mode. I still find it useful for timedot files, but that could change. If anyone wants to champion it, we could explore deprecating and eventually dropping this syntax.