From a8726154ce8465de008714ac10dce783f20def94 Mon Sep 17 00:00:00 2001 From: Jamie Hewland Date: Fri, 18 Sep 2015 15:04:58 +0200 Subject: [PATCH] Tweak some comments --- consular/clients.py | 3 ++- consular/tests/test_main.py | 4 ++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/consular/clients.py b/consular/clients.py index e494816..f841047 100644 --- a/consular/clients.py +++ b/consular/clients.py @@ -37,7 +37,8 @@ def _log_http_error(self, failure, url): def request(self, method, path, endpoint=None, json_data=None, **kwargs): """ Perform a request. A number of basic defaults are set on the request - that make using a JSON API easier. + that make using a JSON API easier. These defaults can be overridden by + setting the parameters in the keyword args. :param: method: The HTTP method to use (example is `GET`). diff --git a/consular/tests/test_main.py b/consular/tests/test_main.py index 6285fe3..2dcc0c5 100644 --- a/consular/tests/test_main.py +++ b/consular/tests/test_main.py @@ -559,8 +559,8 @@ def test_sync_apps(self): def test_sync_apps_field_not_found(self): """ When syncing apps, and Marathon returns a JSON response with an - unexpected structure (the "apps" field is missing. A KeyError should - be raised. + unexpected structure (the "apps" field is missing). A KeyError should + be raised with a useful message. """ d = self.consular.sync_apps(purge=False) marathon_request = yield self.requests.get()