docs: update test docs
This commit is contained in:
parent
39f95d36de
commit
636a3a7d10
24
Tests.hs
24
Tests.hs
@ -1,22 +1,18 @@
|
|||||||
{- |
|
{- |
|
||||||
hledger's test suite. Most tests are HUnit-based, and defined in the
|
hledger's test suite. Most tests are HUnit-based, and defined in the
|
||||||
@tests@ list below. These tests are built in to hledger and can be run at
|
@tests@ list below. These tests are built in to hledger and can be run at
|
||||||
any time with @hledger test@.
|
any time on any platform with @hledger test@.
|
||||||
|
|
||||||
In addition, we have tests in doctest format, which can be run with @make
|
Secondly, we have tests in doctest format, which can be run with @make
|
||||||
doctest@ in the hledger source tree. These have some advantages:
|
doctest@ in the hledger source tree. These have some advantages over
|
||||||
|
hunit: they are sometimes easier to read and write; it is easier to read
|
||||||
|
multi-line output; they can appear in, and test, documentation. On the
|
||||||
|
downside, they are not built in; you need a developer's setup to run them.
|
||||||
|
|
||||||
- easier to read and write than hunit, for functional/shell tests
|
Thirdly, we have command-line functional tests in tests/*.test, which can
|
||||||
|
be run with @make functest@. These are still easier to read and write than
|
||||||
- easier to read multi-line output from failing tests
|
doctests, but likewise are not built in and are more distant from the code
|
||||||
|
they test and you have to come up with sensible filenames.
|
||||||
- can also appear in, and test, docs
|
|
||||||
|
|
||||||
and disadvantages:
|
|
||||||
|
|
||||||
- not included in hledger's built-in tests
|
|
||||||
|
|
||||||
- not platform independent
|
|
||||||
|
|
||||||
Here are the hledger doctests (some may reappear in other modules as
|
Here are the hledger doctests (some may reappear in other modules as
|
||||||
examples):
|
examples):
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user