Inline docs for ``pecan.testing``.

1 files changed, 18 insertions, 0 deletions

diff --git a/pecan/testing.py b/pecan/testing.py
index cb7d09c..e846e35 100644
--- a/pecan/testing.py
+++ b/pecan/testing.py
@@ -3,4 +3,22 @@ from webtest import TestApp
 
 
 def load_test_app(config):
+    """
+    Used for functional tests where you need to test your
+    literal application and its integration with the framework.
+
+    :param config: Can be a dictionary containing configuration, or a string
+                   which represents a (relative) configuration filename.
+
+    returns a pecan.Pecan WSGI application wrapped in a webtest.TestApp
+    instance.
+    ::
+        app = load_test_app('path/to/some/config.py')
+
+        resp = app.get('/path/to/some/resource').status_int
+        assert resp.status_int == 200
+
+        resp = app.post('/path/to/some/resource', params={'param': 'value'})
+        assert resp.status_int == 302
+    """
     return TestApp(load_app(config))