teach_auto/collect_forks.py

@@ -29,7 +29,7 @@ def validate_iso_date(date: str) -> str:
 
 
 def request_forks(project_url: str, header=Dict[str, str]) -> List[Dict]:
-    """Retrieve the metadata from all forks of input project"""
+    """Retrieve the metadata from all forks of input Gitlab project"""
     base, namespace, repo = parse_repo_url(project_url)
     upstream_id = get_project_id(project_url, header)
     # Collect all forks
@@ -153,7 +153,9 @@ def format_fork_metadata(
     help="If you are using a custom renku deployment, you can provide the base url here.",
 )
 def collect_forks(repo_url, token_path, deadline=None, group_only=False, custom_renku_url=None):
-    """Gather metadata about all forks of input project into a JSON file."""
+    """Gather metadata about all forks of input project into a JSON file.
+    REPO_URL must be the URL to the Gitlab repository."""
+
     token = ingest_token(token_path)
     # Check for valid deadline format
     if deadline is not None: