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

;doc: check: edits

Browse Source
This commit is contained in:
Simon Michael 2024-05-02 21:58:52 -10:00
parent 8975988015
commit ad90de62d3
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -37,22 +37,22 @@ These important checks are performed by default, by almost all hledger commands:
- **assertions** - all [balance assertions] in the journal are passing. - **assertions** - all [balance assertions] in the journal are passing.
Balance assertions are like canaries in your journal, they catch many problems. Balance assertions are like canaries in your journal, they catch many problems.
This check can sometimes get in the way, eg when you are troubleshooting bookkeeping errors, This check sometimes gets in the way, eg when troubleshooting bookkeeping errors,
or parsing a journal fragment, so it can be disabled temporarily with `-I`/`--ignore-assertions`. or parsing a journal fragment; you can disable it temporarily with `-I`/`--ignore-assertions`.
### Strict checks ### Strict checks
These additional checks are performed by any command when the `-s`/`--strict` flag is used (AKA [strict mode]). These additional checks are performed by any command when the `-s`/`--strict` flag is used ([strict mode]).
They provide extra error-catching power when you are serious about keeping your data clean and free of typos: They provide extra error-catching power when you are serious about keeping your data clean and free of typos:
- **balanced** - like `autobalanced`, but in [conversion transactions](#recording-costs), - **balanced** - like `autobalanced`, but in [conversion transactions](#recording-costs),
costs must be written explicitly. This ensures some redundancy in the entry, guarding against typos. costs must be written explicitly. This ensures some redundancy in the entry, which helps prevent typos.
- **commodities** - all commodity symbols used [must be declared](#commodity-error-checking). - **commodities** - all commodity symbols used [must be declared](#commodity-error-checking).
This guards against forgetting or mistyping commodity symbols. This guards against mistyping or omitting commodity symbols.
- **accounts** - all account names used [must be declared](#account-error-checking). - **accounts** - all account names used [must be declared](#account-error-checking).
This prevents the use of mistyped or outdated account names. This prevents the use of mis-spelled or outdated account names.
### Other checks ### Other checks