History

NunoSempere 6a83554086 feat: Added notes over pdfs as well as cleaned up the doc a bit note: I don't really like the term "invariants"		2022-04-12 21:24:52 -04:00
..
default.nix	fixed up `default.nix` with correct pandoc command	2022-04-12 18:27:03 -04:00
invariants-apr12.pdf	fixed up `default.nix` with correct pandoc command	2022-04-12 18:27:03 -04:00
invariants.md	feat: Added notes over pdfs	2022-04-12 21:24:52 -04:00
invariants.pdf	feat: Added notes over pdfs	2022-04-12 21:24:52 -04:00
make.sh	fixed up `default.nix` with correct pandoc command	2022-04-12 18:27:03 -04:00
README.md	merge: invariants docs	2022-04-12 20:32:24 -04:00

README.md

Properties

Using nix. Where o is open on OSX and xdg-open on linux,

nix-build
o result/property-tests.pdf

Without nix, you can install pandoc and pdflatex yourself and see make.sh for the rendering command.

Details

The invariants.pdf document is normative and aspirational. It does not document tests as they exist in the codebase, but represents how we think squiggle ought to be tested.

We are partially bottlenecked by the rescript ecosystem's maturity with respect to property-based testing.