chore: add docstring for the git_init_options argument

Signed-off-by: Nathan Nguyen <nathan.nguyen@oracle.com>
oracle · Feb 23, 2024 · c78edd0 · c78edd0
1 parent c0df5e6
commit c78edd0
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/tests/slsa_analyzer/mock_git_utils.py b/tests/slsa_analyzer/mock_git_utils.py
@@ -22,9 +22,14 @@ def initiate_repo(repo_path: str | os.PathLike, git_init_options: dict | None =
 
     Parameters
     ----------
-    repo_path : str or os.PathLike
+    repo_path : str | os.PathLike
         The path to the target repo.
 
+    git_init_options : dict
+        Additional keyword arguments passed to the `git.Repo.init` method.
+        Each key is the name of the argument and each value is the corresponding value
+        for the argument.
+
     Returns
     -------
     Git