diff options
| author | Domen Kožar <domen@dev.si> | 2013-04-25 08:29:47 -0700 |
|---|---|---|
| committer | Domen Kožar <domen@dev.si> | 2013-04-25 08:29:47 -0700 |
| commit | 9a8058ac5fe4bfd5a2bd49e6004f85dd19ed365d (patch) | |
| tree | b5e535179375c7f5efef104b563addd5ac45df74 /docs | |
| parent | d9b389a3e627aa3d61efe41ea9b7a396850774c2 (diff) | |
| parent | bd42a02cf8c4b378e666cbb25a24d15645f34a4f (diff) | |
| download | webtest-9a8058ac5fe4bfd5a2bd49e6004f85dd19ed365d.tar.gz | |
Merge pull request #67 from tshepang/patch-2
various doc improvements
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/index.txt | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/docs/index.txt b/docs/index.txt index d4942b9..d522669 100644 --- a/docs/index.txt +++ b/docs/index.txt @@ -67,12 +67,13 @@ Quick start =========== The most important object in WebTest is :class:`~webtest.TestApp`, the wrapper -for WSGI applications. To use it, you simply instantiate it with your WSGI -application. (Note: if your WSGI application requires any configuration, you -must set that up manually in your tests.) +for WSGI applications. It also allows you to perform HTTP requests on it. +To use it, you simply instantiate it with your WSGI application. -The main class it :class:`~webtest.TestApp` which wrap your WSGI application and -allow you to perform HTTP request on it. +.. note:: + + If your WSGI application requires any configuration, + you must set that up manually in your tests. Here is a basic application:: @@ -91,7 +92,7 @@ Then you can get the response of a HTTP GET:: >>> resp = app.get('/') -And check the result. Like like reponse's status:: +And check the results, like response's status:: >>> assert resp.status == '200 Ok' >>> assert resp.status_int == 200 @@ -106,7 +107,7 @@ Or response's body:: >>> resp.mustcontain('<html>') >>> assert 'form' in resp -WebTest can do much more. In particular it can handle :doc:`forms` and :doc:`json`. +WebTest can do much more. In particular, it can handle :doc:`forms` and :doc:`json`. Contents |