From 3a4fa79e1c707b0f9354677410cc84b1f5db1cb8 Mon Sep 17 00:00:00 2001 From: Erik Johnson Date: Tue, 2 May 2017 11:23:36 -0500 Subject: [PATCH] Documentation fixes for login func This makes a small tweak to the grammar of the documentation for the reauth argument, and also updates the dockercfg_path docs for accuracy. Signed-off-by: Erik Johnson --- docker/api/daemon.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docker/api/daemon.py b/docker/api/daemon.py index 91c777f092..285b7429ad 100644 --- a/docker/api/daemon.py +++ b/docker/api/daemon.py @@ -100,10 +100,11 @@ def login(self, username, password=None, email=None, registry=None, email (str): The email for the registry account registry (str): URL to the registry. E.g. ``https://index.docker.io/v1/`` - reauth (bool): Whether refresh existing authentication on the - Docker server. - dockercfg_path (str): Use a custom path for the ``.dockercfg`` file - (default ``$HOME/.dockercfg``) + reauth (bool): Whether or not to refresh existing authentication on + the Docker server. + dockercfg_path (str): Use a custom path for the Docker config file + (default ``$HOME/.docker/config.json`` if present, + otherwise``$HOME/.dockercfg``) Returns: (dict): The response from the login request