From 94d44d53a52c363e89abc3c9460172b8a272aba1 Mon Sep 17 00:00:00 2001 From: Dave Arnold Date: Wed, 23 Apr 2025 10:52:23 -0700 Subject: [PATCH] Enhance GitHubClient docstring to provide clearer context on API operations and usage --- eks_automation/app.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/eks_automation/app.py b/eks_automation/app.py index be86267..ce1e876 100644 --- a/eks_automation/app.py +++ b/eks_automation/app.py @@ -28,11 +28,11 @@ SECRET_NAME = os.environ["SECRET_NAME"] class GitHubClient: - """A class to interact with GitHub API without relying on external Git binaries.""" + """A class to interact with GitHub API without relying on external Git binaries. This class encapsulates all GitHub API operations for managing repositories, branches, files, commits and other Git operations using only the requests library. - """""" + """ def __init__(self, api_base_url, token, org_name, commit_author_name, commit_author_email, source_version=None, template_repo_name=None, config_file_name="config.json"): """Initialize the GitHub client