Update docstring for GitHub get_workflow workflow argument

A workflow id or (relative) path is allowed here.
greenbone · Sep 21, 2022 · cc28ae3 · cc28ae3
1 parent cf07ea0
commit cc28ae3
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/pontos/github/api.py b/pontos/github/api.py
@@ -699,7 +699,8 @@ def get_workflow(self, repo: str, workflow: str) -> JSON:
 
         Args:
             repo: GitHub repository (owner/name) to use
-            workflow: ID of the workflow
+            workflow: ID of the workflow or workflow file name. For example
+                `main.yml`.
 
         Raises:
             HTTPStatusError: A httpx.HTTPStatusError is raised if the request