diff --git a/hledger/test/errors/README.md b/hledger/test/errors/README.md index 96efcf621..97e5bf0c3 100644 --- a/hledger/test/errors/README.md +++ b/hledger/test/errors/README.md @@ -21,18 +21,22 @@ Each error has - sometimes supplementary data files (like `csvdateparse.csv.rules`) - an autogenerated shelltestrunner test (like `balanced.test`) -*XXX: This is hard to maintain, and has bitrotted/had manual fixups; -the following won't generate accurate passing tests exactly* +## Procedures To update this readme with the latest error messages, run `make readme`. + To regenerate the shelltestrunner tests, run `make tests`. +This is imperfect; some tests will require manual fixups (see also hledger2shelltest). + To test all of these error messages with hledger, run `make test`. +Requires shelltestrunner, the latest version is best. + To test these errors with flycheck-hledger, customize `flycheck-hledger-*` in Emacs to enable all appropriate checks, then open the data files to see how flycheck handles them. `C-c ! l` opens a pane for easy viewing. - + [hledger/test/errors/]: https://github.com/simonmichael/hledger/tree/master/hledger/test/errors [ERRORS]: https://hledger.org/ERRORS.html [hledger check]: https://hledger.org/hledger.html#check