add hpecp/lock 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/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/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/lock.py

@@ -44,16 +44,16 @@ def list(self):
         return self.get()
 
     def create(self, reason=None):
-        """Create a new lock
+        """Create a new lock.
 
-        Arguments:
+        Arguments
+        ---------
+        reason: str
+            Provide a reason for the lock.
 
-            reason: str
-                Provide a reason for the lock
-
-        Raises:
-
-            APIException
+        Raises
+        ------
+        APIException
         """
         data = {"reason": reason}
         return self.client._request(
@@ -64,17 +64,17 @@ def create(self, reason=None):
         )
 
     def delete(self, lock_id):
-        """Delete a lock
-
-        Arguments:
+        """Delete a lock.
 
-            lock_id: str
-                The lock id as retrieved with `get()`  Format:
-                '/api/v1/lock/[0-9]+'
+        Parameters
+        ----------
+        lock_id: str
+            The lock id as retrieved with `get()`  Format:
+            '/api/v1/lock/[0-9]+'
 
-        Raises:
-
-            APIException
+        Raises
+        ------
+        APIException
         """
 
         assert isinstance(
@@ -89,17 +89,17 @@ def delete(self, lock_id):
         )
 
     def delete_all(self, timeout_secs=300):
-        """Delete all locks
-
-        Arguments:
-
-            timeout_secs: int
-                How long to wait for internal locks (note these need to be
-                cleared before external locks can be deleted)
+        """Delete all locks.
 
-        Raises:
+        Parameters
+        ----------
+        timeout_secs: int
+            How long to wait for internal locks (note these need to be
+            cleared before external locks can be deleted)
 
-            APIException
+        Raises
+        ------
+        APIException
         """
 
         try: