Documentation

Commentary

Exemplify-ERT helps you write regression tests that double as clean-looking
examples. Features:

- Write your tests as clean-looking equalities that don't have the noise of
  shoulds and should-nots — but still use ERT behind the scenes.

- If should-equal and should-error aren't enough for you, there's a list of
  other pre-defined equality functions you can use.


Exemplify-ERT is independent from, but goes hand in hand with:

- Exemplify-Align, with which you can align the arrowheads of evaluations.

- Exemplify-Eval, with which you can easily (re)insert arrow and evaluation
  of one or more sexps — with a single keypress.

- OrgReadme-fy, in case you wish to export your tests/examples into a
  nicely-formatted README.org.

- Democratize, which can make your examples show up in Help buffers.

For all the details, please do see the README

Open it easily with:
  (find-file-read-only "README.org")   <--- C-x C-e here¹

or from any buffer:
  M-x exemplify-ert-see-readme

or read it online:
  <https://flandrew.srht.site/listful/sw-emacs-exemplify-ert.html>

¹ or the key that ‘eval-last-sexp’ is bound to, if not C-x C-e.

Requires

Dependencies

Consumers

Reverse Dependencies

No reverse dependencies recorded.