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

;cli: doc: commodity, D directive updates

Browse Source
This commit is contained in:
Simon Michael 2021-03-25 15:26:28 -07:00
parent 4cb9dfb5b8
commit eab66de2ca
1 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
hledger/hledger.m4.md
View File

@ -2320,7 +2320,7 @@ payee Whole Foods
The `commodity` directive has several functions: The `commodity` directive has several functions:
1. It declares commodities which may be used in the journal. 1. It declares commodities which may be used in the journal.
This is currently not enforced, but can serve as documentation. This is enforced in [strict mode](#strict-mode), providing more error-checking.
2. It declares what decimal mark character (period or comma) to expect when parsing 2. It declares what decimal mark character (period or comma) to expect when parsing
input - useful to disambiguate international number formats in your input - useful to disambiguate international number formats in your
@ -2377,14 +2377,16 @@ commodity symbol is used that has not been declared by a [`commodity` directive]
## Default commodity ## Default commodity
The `D` directive sets a default commodity, to be used for amounts without a commodity symbol (ie, plain numbers). The `D` directive sets a default commodity, to be used for any
This commodity will be applied to all subsequent commodity-less amounts, or until the next `D` directive. subsequent commodityless amounts (ie, plain numbers) seen while
(Note, this is different from Ledger's `D`.) parsing the journal. This effect lasts until the next `D` directive,
or the end of the journal.
For compatibility/historical reasons, `D` also acts like a [`commodity` directive](#declaring-commodities), For compatibility/historical reasons, `D` also acts like a [`commodity` directive](#declaring-commodities)
setting the commodity's [display style](#amount-display-format) (for output) and decimal mark (for parsing input). (setting the commodity's decimal mark for parsing and [display style](#amount-display-format) for output).
As with `commodity`, the amount must always be written with a decimal mark (period or comma).
If both directives are used, `commodity`'s style takes precedence. As with `commodity`, the amount must include a decimal mark (either period or comma).
If both `commodity` and `D` directives are used for the same commodity, the `commodity` style takes precedence.
The syntax is `D AMOUNT`. Eg: The syntax is `D AMOUNT`. Eg:
```journal ```journal