libcloud-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From vd...@apache.org
Subject [1/3] libcloud git commit: container/utils: improve docstring for RegistryClient
Date Thu, 22 Nov 2018 06:06:36 GMT
Repository: libcloud
Updated Branches:
  refs/heads/trunk 3d40806f3 -> 90b96de2a


container/utils: improve docstring for RegistryClient

Prior to this change, the docstring for the RegistryClient class was
copy-and-pasted from the HubClient class.

Add the definition for the "host" parameter, and change the descriptions
to reflect the generalized nature of this RegistryClient class.


Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo
Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/51c20cba
Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/51c20cba
Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/51c20cba

Branch: refs/heads/trunk
Commit: 51c20cba417a438379220915d40275688900866a
Parents: 3d40806
Author: Ken Dreyer <kdreyer@redhat.com>
Authored: Wed Nov 21 09:31:50 2018 -0700
Committer: Ken Dreyer <kdreyer@redhat.com>
Committed: Wed Nov 21 09:32:23 2018 -0700

----------------------------------------------------------------------
 libcloud/container/utils/docker.py | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/libcloud/blob/51c20cba/libcloud/container/utils/docker.py
----------------------------------------------------------------------
diff --git a/libcloud/container/utils/docker.py b/libcloud/container/utils/docker.py
index cbf5cf3..c348648 100644
--- a/libcloud/container/utils/docker.py
+++ b/libcloud/container/utils/docker.py
@@ -64,12 +64,15 @@ class RegistryClient(object):
 
     def __init__(self, host, username=None, password=None, **kwargs):
         """
-        Construct a Docker hub client
+        Construct a Docker registry client
 
-        :param username: (optional) Your Hub account username
+        :param host: Your registry endpoint, e.g. 'registry.hub.docker.com'
+        :type  host: ``str``
+
+        :param username: (optional) Your registry account username
         :type  username: ``str``
 
-        :param password: (optional) Your hub account password
+        :param password: (optional) Your registry account password
         :type  password: ``str``
         """
         self.connection = self.connectionCls(host,


Mime
View raw message