fix more doc strings

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

Author: snowch

hpecp/client.py

@@ -18,6 +18,8 @@
 # ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 # OTHER DEALINGS IN THE SOFTWARE.
 
+"""HPE Container Platform Client."""
+
 from __future__ import absolute_import
 
 import configparser
@@ -52,8 +54,9 @@
 
 
 class ContainerPlatformClient(object):
-    """Client object for HPE Container Platform.  This is the central object
-    that users of this library work with.
+    """Client object for HPE Container Platform.
+
+    This is the central object that users of this library work with.
 
     Parameters
     ----------
@@ -126,7 +129,6 @@ def create_from_config_file(
         username = admin
         password = admin123
         """
-
         if profile is None:
             profile = "default"
 
@@ -230,23 +232,24 @@ def get_config_value(key, profile):
 
     @classmethod
     def create_from_env(cls):
-        """Create an instance of ContainerPlatformClient from environment variables:
-
-        Variables::
-
-            HPECP_USERNAME
-            HPECP_PASSWORD
-            HPECP_API_HOST
-            HPECP_API_PORT
-            HPECP_USE_SSL
-            HPECP_VERIFY_SSL
-            HPECP_warn_ssl
-
+        """Create an instance of ContainerPlatformClient from environment variables.
+
+        Variables
+        ---------
+        HPECP_USERNAME
+        HPECP_PASSWORD
+        HPECP_API_HOST
+        HPECP_API_PORT
+        HPECP_USE_SSL
+        HPECP_VERIFY_SSL
+        HPECP_WARN_SSL
+
+        See Also
+        --------
         See ContainerPlatformClient
         :py:class:`constructor <ContainerPlatformClient>` for the paramaeter
         definitions.
         """
-
         if "HPECP_USERNAME" in os.environ:
             HPECP_USERNAME = os.environ["HPECP_USERNAME"]
 
@@ -288,7 +291,6 @@ def __init__(
         verify_ssl=True,
         warn_ssl=False,
     ):
-        """Doc string is defined at the top of the class"""
         self._log = Logger().get_logger(self.__class__.__name__)
 
         if verify_ssl == "True":
@@ -361,13 +363,11 @@ def __init__(
         self._role = RoleController(self)
 
     def create_session(self):
-        """Create a session with the HPE CP controller defined in the object
-
-        :py:class:`ContainerPlatformClient`.
+        """Create a session with the HPE CP controller.
 
         Returns
         -------
-        ContainerPlatformClient:
+        ContainerPlatformClient
             An instance of ContainerPlatformClient is returned.
 
         Raises
@@ -377,7 +377,6 @@ def create_session(self):
             requests.exceptions.RequestException
             for exceptions that are not a connection error
         """
-
         url = self.base_url + "/api/v1/login"
         auth = {"name": self.username, "password": self.password}
 
@@ -569,8 +568,9 @@ def _request(
 
     @property
     def tenant(self):
-        """Reference  to an object of type `.tenant.TenantController`. See
-        the class :py:class:`.tenant.TenantController` for the methods
+        """Retrieve a reference to `.tenant.TenantController` object.
+
+        See the class :py:class:`.tenant.TenantController` for the methods
         available.
 
         Example
@@ -587,8 +587,9 @@ def tenant(self):
 
     @property
     def config(self):
-        """Reference to an object of type `.config.ConfigController`. See
-        the class :py:class:`.config.ConfigController` for the methods
+        """Retrieve a reference to `.config.ConfigController` object.
+
+        See the class :py:class:`.config.ConfigController` for the methods
         available.
 
         Example
@@ -619,12 +620,12 @@ def config(self):
         ...        }
         ...    )
         """  # noqa: E501
-
         return self._config
 
     @property
     def k8s_cluster(self):
-        """Reference to an object of type `.k8s_cluster.K8sClusterController`.
+        """Retrieve a reference to `.k8s_cluster.K8sClusterController` object.
+
         See the class :py:class:`.k8s_cluster.K8sClusterController` for the
         methods available.
 
@@ -642,7 +643,8 @@ def k8s_cluster(self):
 
     @property
     def k8s_worker(self):
-        """Reference to an object of type `.k8s_worker.K8sWorkerController`.
+        """Retrieve a reference to `.k8s_worker.K8sWorkerController` object.
+
         See the class :py:class:`.k8s_worker.K8sWorkerController` for the
         methods available.
 
@@ -660,8 +662,9 @@ def k8s_worker(self):
 
     @property
     def gateway(self):
-        """Reference to an object of type `.gateway.GatewayController`. See
-        the class :py:class:`.gateway.GatewayController` for the methods
+        """Retrieve a reference to `.gateway.GatewayController` object.
+
+        See the class :py:class:`.gateway.GatewayController` for the methods
         available.
 
         Example
@@ -678,8 +681,9 @@ def gateway(self):
 
     @property
     def license(self):
-        """Reference to an object of type `.license.LicenseController`. See
-        the class :py:class:`.license.LicenseController` for the methods
+        """Retrieve a reference to a `.license.LicenseController` object.
+
+        See the class :py:class:`.license.LicenseController` for the methods
         available.
 
         Example
@@ -696,8 +700,10 @@ def license(self):
 
     @property
     def lock(self):
-        """Reference to an object of type `.lock.LockController`. See the
-        class :py:class:`.lock.LockController` for the methods available.
+        """Retrieve a reference to a `.lock.LockController` object.
+
+        See the class :py:class:`.lock.LockController` for the methods
+        available.
 
         Example
         -------
@@ -713,7 +719,9 @@ class :py:class:`.lock.LockController` for the methods available.
 
     @property
     def log(self):
-        """Reference to :py:class:`.logger.Logger`. The log function can be
+        """Retrieve a reference to a `:py:class:`.logger.Logger`.
+
+        The log function can be
         called from controller objects via the `client` parameter passed in
         during instantiation of the controller.
 
@@ -729,13 +737,14 @@ def some_method(self):
                 ...
                 self.client.log.error("Some Error")
         """
-
         return self._log
 
     @property
     def user(self):
-        """Reference to an object of type `.user.UserController`. See the
-        class :py:class:`.lock.UserController` for the methods available.
+        """Retrieve a reference to a `.lock.LockController` object.
+
+        See the class :py:class:`.lock.UserController` for the methods
+        available.
 
         Example
         -------
@@ -751,8 +760,9 @@ class :py:class:`.lock.UserController` for the methods available.
 
     @property
     def catalog(self):
-        """Reference to an object of type `.catalog.CatalogController`. See
-        the class :py:class:`.catalog.CatalogController` for the methods
+        """Retrieve a reference to a `.catalog.CatalogController` object.
+
+        See the class :py:class:`.catalog.CatalogController` for the methods
         available.
 
         Example
@@ -769,8 +779,10 @@ def catalog(self):
 
     @property
     def role(self):
-        """Reference to an object of type `.role.RoleController`. See the
-        class :py:class:`.role.RoleController` for the methods available.
+        """Retrieve a reference to a `.role.RoleController` object.
+
+        See the class :py:class:`.role.RoleController` for the methods
+        available.
 
         Example
         -------

setup.cfg

@@ -4,7 +4,6 @@ description-file = README.md
 [flake8]
 per-file-ignores = hpecp/__init__.py:F401
     # Temporarily disable docstring violations
-    hpecp/client.py:D101,D102,D100,D107,D105,D209,D400,D202,D205,D401,D200,D412	
     hpecp/catalog.py:D101,D102,D100,D107,D105,D209,D400,D202,D205,D401,D200,D412	
     hpecp/config.py:D101,D102,D100,D107,D105,D209,D400,D202,D205,D401,D200,D412	
     hpecp/gateway.py:D101,D102,D100,D107,D105,D209,D400,D202,D205,D401,D200,D412	
@@ -16,7 +15,7 @@ per-file-ignores = hpecp/__init__.py:F401
     hpecp/exceptions.py:D101,D102,D100,D107,D105,D209,D400,D202,D205,D401,D200,D412	
     hpecp/user.py:D101,D102,D100,D107,D105,D209,D400,D202,D205,D401,D200,D412	
     hpecp/tenant.py:D101,D102,D100,D107,D105,D209,D400,D202,D205,D401,D200,D412
-    hpecp/role.py:D101,D102,D100,D107,D105,D209,D400,D202,D205,D401,D200,D412
+exclude = hpecp/role.py
 
 [pycodestyle]
 max-line-length = 79

tests/library/k8s_cluster_test.py

@@ -218,7 +218,7 @@ def test_get_k8sclusters(self, mock_get, mock_post):
             "+-------------+-----------------------+\n"
             "| my cluster  | /api/v2/k8scluster/20 |\n"
             "+-------------+-----------------------+",
-        )  # noqa: E131
+        )
 
 
 class TestCreateCluster(TestCase):