Some explanatory text regarding tests. (@rudigiesler,@justinvdm)

praekeltfoundation · Sep 17, 2014 · 42bbed2 · 42bbed2
1 parent feac40c
commit 42bbed2
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/go_contacts/tests/test_server.py b/go_contacts/tests/test_server.py
@@ -1,5 +1,8 @@
 """
 Tests for contacts API cyclone server.
+
+These tests are run against both the real implementation of the API and the
+verified fake implementation in order to verify that both behave correctly.
 """
 
 import yaml

diff --git a/verified-fake/README.rst b/verified-fake/README.rst
@@ -2,3 +2,6 @@ Fake Go Contacts API
 ====================
 
 A verified fake implementation of go-contacts for use in tests.
+
+This implementation is tested in the go-contacts package alongside the API it
+is faking, to ensure that the behaviour is the same for both.
diff --git a/verified-fake/fake_go_contacts.py b/verified-fake/fake_go_contacts.py
@@ -1,3 +1,11 @@
+"""
+A verified fake implementation of go-contacts for use in tests.
+
+This implementation is tested in the go-contacts package alongside the API it
+is faking, to ensure that the behaviour is the same for both.
+"""
+
+
 import json
 from uuid import uuid4
 from urlparse import urlparse, parse_qs