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

;doc:check: cleanup

Browse Source
This commit is contained in:
Simon Michael 2023-08-22 09:56:25 +01:00
parent ea55c75c2e
commit 50f26c280e
1 changed files with 9 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -24,13 +24,12 @@ providing instant feedback as you edit the journal.
Here are the checks currently available: Here are the checks currently available:
### Basic checks ### Default checks
These checks are always run automatically, by (almost) all hledger commands, These checks are run automatically by (almost) all hledger commands:
including `check`:
- **parseable** - data files are well-formed and can be - **parseable** - data files are in a supported [format](hledger.md#data-formats),
[successfully parsed](hledger.html#input-files) with no syntax errors and no invalid include directives.
- **autobalanced** - all transactions are [balanced](hledger.html#postings), after converting to cost. - **autobalanced** - all transactions are [balanced](hledger.html#postings), after converting to cost.
Missing amounts and missing [costs] are inferred automatically where possible. Missing amounts and missing [costs] are inferred automatically where possible.
@ -43,20 +42,20 @@ including `check`:
These additional checks are run when the `-s`/`--strict` ([strict mode]) flag is used. These additional checks are run when the `-s`/`--strict` ([strict mode]) flag is used.
Or, they can be run by giving their names as arguments to `check`: Or, they can be run by giving their names as arguments to `check`:
- **balanced** - all transactions are balanced after converting to cost,
without inferring missing costs.
If conversion costs are required, they must be explicit.
- **accounts** - all account names used by transactions - **accounts** - all account names used by transactions
[have been declared](hledger.html#account-error-checking) [have been declared](hledger.html#account-error-checking)
- **commodities** - all commodity symbols used - **commodities** - all commodity symbols used
[have been declared](hledger.html#commodity-error-checking) [have been declared](hledger.html#commodity-error-checking)
- **balanced** - all transactions are balanced after converting to cost,
without inferring missing costs.
If conversion costs are required, they must be explicit.
### Other checks ### Other checks
These checks can be run only by giving their names as arguments to `check`. These checks can be run only by giving their names as arguments to `check`.
They are more specialised and not desirable for everyone, therefore optional: They are more specialised and not desirable for everyone:
- **ordereddates** - transactions are ordered by date within each file - **ordereddates** - transactions are ordered by date within each file