Add comments to EQC test explaining what it does

circles-learning-labs · Mar 12, 2018 · 87755b1 · 87755b1
1 parent e317aa5
commit 87755b1
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/test/adapter_state_eqc_test.exs b/test/adapter_state_eqc_test.exs
@@ -1,6 +1,10 @@
 # Skip EQC testing if we don't have it installed:
 if Code.ensure_compiled?(:eqc) do
 defmodule AdapterStateEqcTest do
+  # This test runs a series of database operations through the adapter
+  # and checks that everything appears to stay consistent and follow
+  # all the rules the way we expect it to.
+
   use ExUnit.Case
   use EQC.ExUnit
   use EQC.StateM