slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

;doc: csv, timeclock, timedot: clarify comment lines (#1953)

Browse Source
This commit is contained in:
Simon Michael 2022-12-06 10:38:50 -10:00
parent b81e358163
commit b50d60cfea
2 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
hledger-lib/Hledger/Read/CsvReader.hs
View File

@ -400,7 +400,7 @@ VALUE: SPACE? ( CHAR* ) SPACE?
COMMENT: SPACE? COMMENT-CHAR VALUE COMMENT: SPACE? COMMENT-CHAR VALUE
COMMENT-CHAR: # | ; COMMENT-CHAR: # | ; | *
NONSPACE: any CHAR not a SPACE-CHAR NONSPACE: any CHAR not a SPACE-CHAR

19
hledger/hledger.m4.md
View File

@ -4254,7 +4254,7 @@ $ hledger -f paypal-custom.csv print
## CSV rules ## CSV rules
The following kinds of rule can appear in the rules file, in any order. The following kinds of rule can appear in the rules file, in any order.
Blank lines and lines beginning with `#` or `;` are ignored. Blank lines and lines beginning with `#` or `;` or `*` are ignored.
### `skip` ### `skip`
@ -5091,6 +5091,7 @@ The date is a [simple date](#simple-dates).
The time format is HH:MM[:SS][+-ZZZZ]. Seconds and timezone are optional. The time format is HH:MM[:SS][+-ZZZZ]. Seconds and timezone are optional.
The timezone, if present, must be four digits and is ignored The timezone, if present, must be four digits and is ignored
(currently the time is always interpreted as a local time). (currently the time is always interpreted as a local time).
Lines beginning with `#` or `;` or `*`, and blank lines, are ignored.
```timeclock ```timeclock
i 2015/03/30 09:00:00 some:account name optional description after two spaces i 2015/03/30 09:00:00 some:account name optional description after two spaces
@ -5141,10 +5142,9 @@ To generate time logs, ie to clock in and clock out, you could:
- or use the old `ti` and `to` scripts in the [ledger 2.x repository](https://github.com/ledger/ledger/tree/maint/scripts). - or use the old `ti` and `to` scripts in the [ledger 2.x repository](https://github.com/ledger/ledger/tree/maint/scripts).
These rely on a "timeclock" executable which I think is just the ledger 2 executable renamed. These rely on a "timeclock" executable which I think is just the ledger 2 executable renamed.
# TIMEDOT FORMAT # TIMEDOT FORMAT
`timedot` format is hledger's human-friendly time logging format. `timedot` format is hledger's human-friendly time logging format.
Compared to [`timeclock` format](#timeclock-format), it is Compared to [`timeclock` format](#timeclock-format), it is
@ -5219,17 +5219,18 @@ In more detail, timedot amounts can be:
There is some added flexibility to help with keeping time log data There is some added flexibility to help with keeping time log data
in the same file as your notes, todo lists, etc.: in the same file as your notes, todo lists, etc.:
- Lines beginning with `#` or `;`, and blank lines, are ignored. - Blank lines and lines beginning with `#` or `;` are ignored.
- Before the first date line, lines beginning with `*` are ignored.
From the first date line onward, a sequence of `*`'s followed by a space
at beginning of lines (ie, the headline prefix used by Emacs Org mode) is ignored.
This means the time log can be kept under an Org headline,
and date lines or time transaction lines can be Org headlines.
- Lines not ending with a double-space and amount are - Lines not ending with a double-space and amount are
parsed as transactions with zero amount. parsed as transactions with zero amount.
(Most hledger reports hide these by default; add -E to see them.) (Most hledger reports hide these by default; add -E to see them.)
- One or more stars (`*`) followed by a space, at the start of a line, is ignored.
So date lines or time transaction lines can also be Org-mode headlines.
- All Org-mode headlines before the first date line are ignored.
More examples: More examples:
```timedot ```timedot