From 42bbed26bf8facee565ef23678e2d9738b0cc432 Mon Sep 17 00:00:00 2001
From: Jeremy Thurgood <jeremy@praekelt.com>
Date: Wed, 17 Sep 2014 12:05:00 +0200
Subject: [PATCH] Some explanatory text regarding tests.
 (@rudigiesler,@justinvdm)

---
 go_contacts/tests/test_server.py  | 3 +++
 verified-fake/README.rst          | 3 +++
 verified-fake/fake_go_contacts.py | 8 ++++++++
 3 files changed, 14 insertions(+)

diff --git a/go_contacts/tests/test_server.py b/go_contacts/tests/test_server.py
index 1a1babf..d6d2729 100644
--- 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
index ba6e911..2dfb4b6 100644
--- 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
index 922b2f8..49f4932 100644
--- 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