summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoffrey F <joffrey@docker.com>2015-04-22 11:28:59 -0700
committerJoffrey F <joffrey@docker.com>2015-04-22 11:28:59 -0700
commite1a6f2e0fff5c1267a3660d68078834c488a0cac (patch)
treedd67a63301cdf40ef5466e81e8f1bb599dd4aebd
parent14459560102fb3b541b4b15e3ce8a181ac891fa9 (diff)
downloaddocker-py-e1a6f2e0fff5c1267a3660d68078834c488a0cac.tar.gz
Small docs clarification
-rw-r--r--docs/api.md1
1 files changed, 1 insertions, 0 deletions
diff --git a/docs/api.md b/docs/api.md
index b3a071f..848401d 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -503,6 +503,7 @@ Identical to the `docker pull` command.
* stream (bool): Stream the output as a generator
* insecure_registry (bool): Use an insecure registry
* auth_config (dict): Override the credentials that Client.login has set for this request
+ `auth_config` should contain the `username` and `password` keys to be valid.
**Returns** (generator or str): The output