C0115 missing class docstring--pylint--enabled

Author: Bryan Sieber

pyproject.toml

@@ -45,8 +45,6 @@ testpaths = [
 [tool.pylint]
     [tool.pylint.'MESSAGES CONTROL']
     disable = [
-#        "C0114", #missing-module-docstring
-        "C0115", #missing-class-docstring
         "C0116", #missing-function-docstring
         "C0301", #line-too-long
         "R0903", #too-few-public-methods

src/app/environment.py

@@ -9,6 +9,10 @@
 
 
 class Settings(BaseSettings):
+    """
+    The Settings object extracts environment variables for convenience
+    """
+
     host: str = "0.0.0.0"
     port: str = "80"
     app_reload: bool = True

src/jbi/configuration.py

@@ -17,11 +17,15 @@
 
 
 class ConfigError(Exception):
-    pass
+    """
+    Errors used to determine when the Configuration is invalid
+    """
 
 
 class ProcessError(Exception):
-    pass
+    """
+    Error when an exception occurs during processing
+    """
 
 
 def get_yaml_configurations(

src/jbi/whiteboard_actions/default.py

@@ -14,6 +14,10 @@ def init(whiteboard_tag, jira_project_key, **kwargs):
 
 
 class DefaultExecutor:
+    """
+    Callable class that encapsulates the default action
+    """
+
     def __init__(self, **kwargs):
         self.parameters = kwargs
         self.whiteboard_tag = kwargs.get("whiteboard_tag")