C0114 from pylint--enabled

Author: Bryan Sieber

infra/gunicorn_conf.py

@@ -1,4 +1,7 @@
-# From: https://github.com/tiangolo/uvicorn-gunicorn-docker/blob/2daa3e3873c837d5781feb4ff6a40a89f791f81b/docker-images/gunicorn_conf.py
+"""
+Conf file extracted from:
+https://github.com/tiangolo/uvicorn-gunicorn-docker/blob/2daa3e3873c837d5781feb4ff6a40a89f791f81b/docker-images/gunicorn_conf.py
+"""
 # pylint: disable=invalid-name
 
 import multiprocessing

pyproject.toml

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

src/app/api.py

@@ -1,3 +1,6 @@
+"""
+Core FastAPI app (setup, middleware)
+"""
 import logging
 import time
 from datetime import datetime

src/app/environment.py

@@ -1,3 +1,6 @@
+"""
+Module dedicated to interacting with the environment (variables, version.json)
+"""
 import json
 import os
 from functools import lru_cache

src/app/log.py

@@ -1,3 +1,6 @@
+"""
+Dedicated module for logging configuration and setup
+"""
 import logging
 import logging.config
 import sys

src/app/monitor.py

@@ -1,3 +1,6 @@
+"""
+Router dedicated to Dockerflow APIs
+"""
 from typing import Dict
 
 from fastapi import APIRouter, Depends, Request

src/jbi/configuration.py

@@ -1,3 +1,6 @@
+"""
+Parsing and validating the YAML configuration occurs within this module
+"""
 import importlib
 import logging
 from inspect import signature

src/jbi/router.py

@@ -1,3 +1,6 @@
+"""
+Router dedicated to Jira Bugzilla Integration APIs
+"""
 import logging
 from typing import Optional
 

src/jbi/services.py

@@ -1,3 +1,6 @@
+"""
+Services and functions that can be used to create custom actions
+"""
 import logging
 
 import bugzilla as rh_bugzilla  # type: ignore

src/jbi/whiteboard_actions/default.py

@@ -1,5 +1,10 @@
-# Default actions below
-# from src.jbi import services
+"""
+Default actions is listed below.
+`init` is required; and requires at minimum the
+`whiteboard_tag` and `jira_project_key`.
+
+`init` should return a __call__able
+"""
 
 
 def init(whiteboard_tag, jira_project_key, **kwargs):