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

;doc: update --value-at support, add more report details (#329)

Browse Source
This commit is contained in:
Simon Michael 2019-05-05 17:48:20 -07:00
parent ad00da244b
commit 30a35230d2
1 changed files with 54 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
hledger/hledger_options.m4.md
View File

@ -600,25 +600,63 @@ $ hledger -f- print --value-at=2000-01-15
### Reports supporting --value-at
All report/--value-at combinations are expected to do the right
thing, or at least a reasonable thing. If you find problems, please
report them (with reproducible examples) eg at
[#329](https://github.com/simonmichael/hledger/issues/329).
Currently all report/--value-at combinations are expected to do the
right thing, or at least a reasonable thing.
Though, some of these combinations might not make sense.
The table below shows the current status as far as we know it.
(Here "print", "register", "balance" mean all commands of those
general types, and "-M" means any report interval):
("print", "register", "balance" mean all commands of those general
types, "-M" means any report interval, "Y" means supported):
| Report type | `--value-at=` `transaction`  | `--value-at=` `period`  | `--value-at=` `DATE`/`now`  |
|----------------------------|:---------------------------------:|:----------------------------:|:--------------------------------:|
| Report type | `--value-at` `transaction`  | `--value-at` `period`  | `--value-at` `DATE`/`now`  |
|-----------------------|:--------------------------------:|:---------------------------:|:-------------------------------:|
| print | Y | Y | Y |
| register | Y | Y | Y |
| register -M | Y | Y | Y |
| register -H | ? | ? | ? |
| register -M | *retest* | Y | Y |
| register -H | Y | Y | Y |
| balance | Y | Y | Y |
| balance -M -T/-A | Y | Y | Y |
| balance -M -H | - | - | - |
| balance -MTA | Y | Y | Y |
| balance -MH | *not yet* | *not yet* | *not yet* |
| balance --budget | ? | ? | ? |
If you find problems (useless reports, misbehaving reports, or errors
being reported), please report them (with reproducible examples) eg at
[#329](https://github.com/simonmichael/hledger/issues/329).
Some more notes specific to the report types:
#### print --value-at
Posting amounts are converted to value, but balance assertion/balance assignment amounts are not.
#### register --value-at
register --value-at
transaction: convert each posting to value at posting date ; with -H, convert starting balance to value at day before report start
period: convert each posting to value at report end ; with -H, convert starting balance to value at day before report start
date: convert each posting to value at date ; with -H, convert starting balance to value at date
register -M --value-at
transaction: convert each summary posting to value at posting date ; with -H, convert starting balance to value at day before report start
period: convert each summary posting to value at period end ; with -H, convert starting balance to value at day before report start
date: convert each summary posting to value at date ; with -H, convert starting balance to value at date
"Day before report start" is a bit arbitrary.
In all cases, the running total/average is calculated from the above numbers.
#### balance --value-at
balance --value-at
transaction: convert each posting to value before summing
period: convert totals to value at period end
date: convert totals to value at date
balance -M --value-at
transaction: convert each posting to value before calculating table cell amounts
period: convert each table cell amount (balance change or ending balance) to its value at period end
date: convert each table cell amount to its value at date
## Combining -B and -V
Using -B/--cost and -V/--value together is currently allowed, but the