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

test: update docs

Browse Source 
[ci skip]
This commit is contained in:
Simon Michael 2018-09-06 12:02:29 -07:00
parent 622153e022
commit d93334738b
1 changed files with 9 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
hledger/hledger_commands.m4.md
View File

@ -787,20 +787,17 @@ With additional QUERY arguments, only transactions matching the query are consid
## test ## test
Run built-in unit tests. Run built-in unit tests.
This command runs hledger's built-in unit tests and displays a quick report. Prints test names and their results on stdout.
It's mainly used during development, but it's also nice to be able to
sanity-check your installed hledger executable at any time.
It runs the unit tests built in to hledger-lib and hledger,
printing results on stdout and exiting with success or failure.
Tests are run in two batches: easytest-based and hunit-based tests.
If any test fails or gives an error, the exit code will be non-zero. If any test fails or gives an error, the exit code will be non-zero.
If a pattern argument (case sensitive) is provided, only easytests Test names include a group prefix.
in that scope and only hunit tests whose name contains it are run. If a (exact, case sensitive) group prefix, or a full test name is provided as the first argument,
only that group or test is run.
If a numeric second argument is provided, it will set the randomness If a numeric second argument is provided, it will set the randomness seed,
seed for easytests. for repeatable results from tests using randomness (currently none of them).
This is mainly used by developers, but it's nice to be able to sanity-check your installed hledger executable at any time.
All tests are expected to pass - if you ever see otherwise, something has gone wrong, please report a bug!
_include_(hledger_addons.m4.md) _include_(hledger_addons.m4.md)