summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoffrey F <joffrey@docker.com>2015-03-05 12:12:02 -0800
committerJoffrey F <joffrey@docker.com>2015-03-05 12:12:02 -0800
commit6f18b4a86fb13eefe3330cf0e1aba8a036bb4842 (patch)
treea0e510269a8c64aa26a12cf23ee5b226fc718cb6
parentacfa99dd10f5b0ffcea4c52fe45aa583e4596823 (diff)
downloaddocker-py-6f18b4a86fb13eefe3330cf0e1aba8a036bb4842.tar.gz
Mention version='auto' in docs
-rw-r--r--docs/api.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/api.md b/docs/api.md
index 9e550a9..8172b7b 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -12,7 +12,8 @@ c = Client(base_url='unix://var/run/docker.sock')
* base_url (str): Refers to the protocol+hostname+port where the Docker server
is hosted.
-* version (str): The version of the API the client will use
+* version (str): The version of the API the client will use. Specify `'auto'`
+ to use the API version provided by the server.
* timeout (int): The HTTP request timeout, in seconds.
* tls (bool or [TLSConfig](tls.md#TLSConfig)): Equivalent CLI options: `docker --tls ...`