Skip to content

Commit 3a4fa79

Browse files
committed
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 <[email protected]>
1 parent 72b9b72 commit 3a4fa79

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

docker/api/daemon.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -100,10 +100,11 @@ def login(self, username, password=None, email=None, registry=None,
100100
email (str): The email for the registry account
101101
registry (str): URL to the registry. E.g.
102102
``https://index.docker.io/v1/``
103-
reauth (bool): Whether refresh existing authentication on the
104-
Docker server.
105-
dockercfg_path (str): Use a custom path for the ``.dockercfg`` file
106-
(default ``$HOME/.dockercfg``)
103+
reauth (bool): Whether or not to refresh existing authentication on
104+
the Docker server.
105+
dockercfg_path (str): Use a custom path for the Docker config file
106+
(default ``$HOME/.docker/config.json`` if present,
107+
otherwise``$HOME/.dockercfg``)
107108
108109
Returns:
109110
(dict): The response from the login request

0 commit comments

Comments
 (0)