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

;doc:check: edits

Browse Source
This commit is contained in:
Simon Michael 2025-04-24 11:13:29 -10:00
parent 650901901f
commit d37000726d
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
hledger/Hledger/Cli/Commands/Check.md
View File

@ -34,23 +34,23 @@ These important checks are performed by default, by almost all hledger commands:
This ensures that all files exist and are readable. This ensures that all files exist and are readable.
- **autobalanced** - all transactions are [balanced](#postings), - **autobalanced** - all transactions are [balanced](#postings),
after inferring missing amounts and conversion [costs] where possible, after automatically inferring missing amounts and conversion rates
and then converting to cost. and then converting amounts to cost.
This ensures that each transaction's entry is well formed. This ensures that each transaction's entry is well formed.
- **assertions** - all [balance assertions] in the journal are passing. - **assertions** - all [balance assertions] in the journal are passing.
Balance assertions are a strong defense against errors; they help catch many problems. Balance assertions are a strong defense against errors; they help catch many problems.
You can disable this check by adding `-I`/`--ignore-assertions` to a command or to your config file. (You can disable this check by adding `-I`/`--ignore-assertions` to a command or to your config file.
When you want to re-enable it, use `-s`/`--strict` or `hledger check assertions`. When you want to re-enable it, use `-s`/`--strict` or `hledger check assertions`.)
### Strict checks ### Strict checks
These additional checks are performed by any command when the `-s`/`--strict` flag is used ([strict mode]). These additional checks are performed by all commands when the `-s`/`--strict` flag is used ([strict mode]).
Strict mode also always enables the `assertions` check. Strict mode also always enables the `assertions` check.
These provide extra error-catching power when you are serious about keeping your data clean and free of typos: These provide extra error-catching power to keep your data clean and correct:
- **balanced** - more strict than `autobalanced`: any commodity conversions must be explicit, - **balanced** - like `autobalanced`, but all conversions between commodities must
using either [cost notation](#recording-costs) or [equity postings](#equity-conversion-postings). use explicit [cost notation](#recording-costs) or [equity postings](#equity-conversion-postings).
This prevents wrong conversions caused by typos. This prevents wrong conversions caused by typos.
- **commodities** - all commodity symbols used must be [declared](#commodity-error-checking). - **commodities** - all commodity symbols used must be [declared](#commodity-error-checking).