summaryrefslogtreecommitdiff
path: root/src/mailman/tests/test_documentation.py
diff options
context:
space:
mode:
authorBarry Warsaw2011-04-01 18:56:17 -0400
committerBarry Warsaw2011-04-01 18:56:17 -0400
commitcd18f50624f33a9556492168933d5fe088d51a04 (patch)
treecf9f9176e040f8af5b39240c0cd97c2b48c29952 /src/mailman/tests/test_documentation.py
parent477d81701e0e3ef166b786de9ec9bc1f148eaffe (diff)
parent33ad44bc97f08df71f227f6f2a006e770a75c353 (diff)
downloadmailman-cd18f50624f33a9556492168933d5fe088d51a04.tar.gz
mailman-cd18f50624f33a9556492168933d5fe088d51a04.tar.zst
mailman-cd18f50624f33a9556492168933d5fe088d51a04.zip
Diffstat (limited to 'src/mailman/tests/test_documentation.py')
-rw-r--r--src/mailman/tests/test_documentation.py4
1 files changed, 3 insertions, 1 deletions
diff --git a/src/mailman/tests/test_documentation.py b/src/mailman/tests/test_documentation.py
index 23cc189d0..2a72a367f 100644
--- a/src/mailman/tests/test_documentation.py
+++ b/src/mailman/tests/test_documentation.py
@@ -126,7 +126,7 @@ def dump_list(list_of_things, key=str):
def call_http(url, data=None, method=None, username=None, password=None):
- """'Call' a URL with a given HTTP method and return the resulting object.
+ """'Call a URL with a given HTTP method and return the resulting object.
The object will have been JSON decoded.
@@ -142,6 +142,8 @@ def call_http(url, data=None, method=None, username=None, password=None):
:param password: The HTTP Basic Auth password. None means use the value
from the configuration.
:type username: str
+ :return: The decoded JSON data structure.
+ :raises HTTPError: when a non-2xx return code is received.
"""
headers = {}
if data is not None: