aboutsummaryrefslogtreecommitdiffstats
path: root/docs/dev
diff options
context:
space:
mode:
authorMaximilian Hils <git@maximilianhils.com>2016-04-11 14:13:48 -0700
committerMaximilian Hils <git@maximilianhils.com>2016-04-11 14:13:48 -0700
commit14e9b0a0ac5ca8c1177e0e501906f43511798ca1 (patch)
tree26ab091fbfe48d07e02c2ac828fadafff6427269 /docs/dev
parent7208a7543f4ad04cfbf304a66ea857540dbb0989 (diff)
downloadmitmproxy-14e9b0a0ac5ca8c1177e0e501906f43511798ca1.tar.gz
mitmproxy-14e9b0a0ac5ca8c1177e0e501906f43511798ca1.tar.bz2
mitmproxy-14e9b0a0ac5ca8c1177e0e501906f43511798ca1.zip
docs: better data structure docs
Diffstat (limited to 'docs/dev')
-rw-r--r--docs/dev/models.rst10
-rw-r--r--docs/dev/testing.rst2
2 files changed, 8 insertions, 4 deletions
diff --git a/docs/dev/models.rst b/docs/dev/models.rst
index 7a949941..2eac6783 100644
--- a/docs/dev/models.rst
+++ b/docs/dev/models.rst
@@ -1,7 +1,11 @@
.. _models:
-Models
-======
+Datastructures
+==============
+
+.. automodule:: mitmproxy.models
+ :members: HTTPFlow, HTTPRequest, HTTPResponse
+
.. automodule:: netlib.http
@@ -56,4 +60,4 @@ Models
.. automodule:: mitmproxy.models
:show-inheritance:
- :members: HTTPFlow, Error, ClientConnection, ServerConnection \ No newline at end of file
+ :members: Error, ServerConnection, ClientConnection \ No newline at end of file
diff --git a/docs/dev/testing.rst b/docs/dev/testing.rst
index e3b86bf3..c9ed5164 100644
--- a/docs/dev/testing.rst
+++ b/docs/dev/testing.rst
@@ -10,7 +10,7 @@ suitable extension to the test suite.
Our tests are written for the `py.test`_ or nose_ test frameworks.
At the point where you send your pull request, a command like this:
->>> py.test -n 4 --cov mitmproxy
+>>> py.test --cov mitmproxy --cov netlib
Should give output something like this: