add hpecp/k8s_worker doc check

Signed-off-by: Chris Snow <[email protected]>

Author: snowch

.travis.yml

@@ -36,7 +36,7 @@ jobs:
       install:
         - pip3 install flake8 flake8-docstrings flake8-per-file-ignores
       script:
-        - flake8 --exclude hpecp/gateway.py,hpecp/logger.py,hpecp/lock.py,hpecp/k8s_cluster.py,hpecp/k8s_worker.py,hpecp/license.py,hpecp/user.py,hpecp/tenant.py,hpecp/role.py --docstring-convention numpy bin/ hpecp/
+        - flake8 --exclude hpecp/gateway.py,hpecp/logger.py,hpecp/lock.py,hpecp/k8s_cluster.py,hpecp/license.py,hpecp/user.py,hpecp/tenant.py,hpecp/role.py --docstring-convention numpy bin/ hpecp/
     - stage: coverage_library
       name: "Code coverage LIBRARY (./hpecp)"
       python: 3.8

hpecp/k8s_worker.py

@@ -144,18 +144,22 @@ def create_with_ssh_password(self, username, password):
         raise NotImplementedError()
 
     def create_with_ssh_key(self, ip, ssh_key_data, tags=[]):
-        """Create a gateway instance using SSH key credentials to access the host
-
-        Args:
-            ip: str
-                The IP address of the proxy host.  Used for internal
-                communication.
-            ssh_key_data: str
-                The ssh key data as a string.
-            tags: list
-                Tags to use, e.g. "{ 'tag1': 'foo', 'tag2', 'bar' }".
-
-        Returns: Worker ID
+        """Create a gateway instance using SSH key credentials to access the host.
+
+        Parameters
+        ----------
+        ip: str
+            The IP address of the proxy host.  Used for internal
+            communication.
+        ssh_key_data: str
+            The ssh key data as a string.
+        tags: list
+            Tags to use, e.g. "{ 'tag1': 'foo', 'tag2', 'bar' }".
+
+        Returns
+        -------
+        string
+            Worker ID
         """
 
         assert isinstance(
@@ -221,22 +225,26 @@ def delete(self, worker_id):
     def wait_for_status(self, worker_id, status=[], timeout_secs=1200):
         """Wait for K8S worker status.
 
-        Args:
-            worker_id: str
-                The worker ID - format: '/api/v1/workers/[0-9]+'
-            status: list[:py:class:`WorkerK8sStatus`]
-                Status(es) to wait for.  Use an empty array if you want to
-                wait for a cluster's existence to cease.
-            timeout_secs: int
-                How long to wait for the status(es) before raising an
-                exception.
-
-        Returns:
-            bool: True if status was found before timeout, otherwise False
-
-        Raises:
-            APIItemNotFoundException: if the item is not found and status is
-            not empty
+        Parameters
+        ----------
+        worker_id: str
+            The worker ID - format: '/api/v1/workers/[0-9]+'
+        status: list[:py:class:`WorkerK8sStatus`]
+            Status(es) to wait for.  Use an empty array if you want to
+            wait for a cluster's existence to cease.
+        timeout_secs: int
+            How long to wait for the status(es) before raising an
+            exception.
+
+        Returns
+        -------
+        bool
+            True if status was found before timeout, otherwise False
+
+        Raises
+        ------
+        APIItemNotFoundException
+            If the item is not found and status is not empty
             APIException: if a generic API exception occurred
         """
         assert isinstance(