summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGabriel Falcão <gabriel@nacaolivre.org>2020-03-26 00:26:35 +0100
committerGabriel Falcão <gabriel@nacaolivre.org>2020-03-26 00:26:35 +0100
commit0d88bb916040d08c9d08bc40e4e1ce239ddf7a72 (patch)
tree0cfbd23f8e3f8fa1ccad33be60f48c74fae4c2a1
parentc24c3f345e26816dcae9a4881686fcfdc3fbad18 (diff)
downloadhttpretty-0d88bb916040d08c9d08bc40e4e1ce239ddf7a72.tar.gz
update docstrings
-rw-r--r--docs/source/api.rst1
-rw-r--r--docs/source/introduction.rst3
-rw-r--r--httpretty/__init__.py8
3 files changed, 11 insertions, 1 deletions
diff --git a/docs/source/api.rst b/docs/source/api.rst
index 8cca31d..a94f65b 100644
--- a/docs/source/api.rst
+++ b/docs/source/api.rst
@@ -36,6 +36,7 @@ latest_requests
.. autofunction:: httpretty.latest_requests
+.. automodule:: httpretty
.. _activate:
diff --git a/docs/source/introduction.rst b/docs/source/introduction.rst
index c011371..836a5d2 100644
--- a/docs/source/introduction.rst
+++ b/docs/source/introduction.rst
@@ -18,9 +18,10 @@ Don't worry, HTTPretty is here for you:
::
import requests
- from sure import expect
import httpretty
+ from sure import expect
+
@httpretty.activate
def test_yipit_api_returning_deals():
diff --git a/httpretty/__init__.py b/httpretty/__init__.py
index e3b3f20..9051af3 100644
--- a/httpretty/__init__.py
+++ b/httpretty/__init__.py
@@ -57,13 +57,21 @@ reset = httpretty.reset
Response = httpretty.Response
GET = httpretty.GET
+"""Match requests of GET method"""
PUT = httpretty.PUT
+"""Match requests of PUT method"""
POST = httpretty.POST
+"""Match requests of POST method"""
DELETE = httpretty.DELETE
+"""Match requests of DELETE method"""
HEAD = httpretty.HEAD
+"""Match requests of HEAD method"""
PATCH = httpretty.PATCH
+"""Match requests of OPTIONS method"""
OPTIONS = httpretty.OPTIONS
+"""Match requests of OPTIONS method"""
CONNECT = httpretty.CONNECT
+"""Match requests of CONNECT method"""
def last_request():