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

imp: bal: doc: --commodity-column tweaks (#1626)

Browse Source 
- promote the heading one level
- periodic CSV reports are supported too
- slight edits to manual and flag description
This commit is contained in:
Simon Michael 2021-08-08 09:32:30 -10:00
parent 1be74a01ce
commit 30ea463060
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
hledger/Hledger/Cli/Commands/Balance.hs
View File

@ -311,7 +311,7 @@ balancemode = hledgerCommandMode
,flagNone ["invert"] (setboolopt "invert") "display all amounts with reversed sign"
,flagNone ["transpose"] (setboolopt "transpose") "transpose rows and columns"
,flagNone ["commodity-column"] (setboolopt "commodity-column")
"shows one row per commodity and puts the commodity symbol in its own column, leaving amounts as bare numbers"
"show commodity symbols in a separate column, amounts as bare numbers, one row per commodity"
,outputFormatFlag ["txt","html","csv","json"]
,outputFileFlag
]

12
hledger/Hledger/Cli/Commands/Balance.md
View File

@ -256,12 +256,11 @@ Here are some ways to handle that:
[csv-mode]: https://elpa.gnu.org/packages/csv-mode.html
[visidata]: https://www.visidata.org
#### commodity column
### Commodity column
With `--commodity-column`, each commodity of an account is displayed as a
separate row item row will only include the quantity. The commodity itself is
shown as a separate column, one per row. This can be useful for a cleaner
display of multi-period reports with many commodities
With `--commodity-column`, commodity symbols are displayed in a separate column, and amounts are displayed as bare numbers.
In this mode, each report row will show amounts for a single commodity, using extra rows when necessary.
It can be useful for a cleaner display of reports with many commodities:
```shell
$ hledger bal -T -Y
@ -291,7 +290,8 @@ Balance changes in 2012-01-01..2014-12-31:
|| VHT 106.00 18.00 170.00 294.00
```
Single-period CSV balance reports also follow this new convention.
This flag also affects [CSV output](#output-formats),
which is useful for producing data that is easier to consume, eg when making charts:
```shell
$ hledger bal -T -O csv