slight refactor, doc

src/submission/submit.py

@@ -35,10 +35,6 @@ def add_new_solutions(
     is_warmup_dataset: bool,
     ensure_all_present: bool = False,
 ):
-    # Rate limits:
-    #   1. Users must wait MIN_WAIT_TIME_PER_USER_HRS hours between submissions.
-    #   2. No more than MAX_SUBMISSIONS_PER_WINDOW submissions RATE_LIMIT_WINDOW_HRS hours overall.
-
     try:
         submitted_ids = get_dataset_config_names(SUBMISSIONS_REPO, token=TOKEN)
     except (DatasetNotFoundError, FileNotFoundError):
@@ -46,14 +42,19 @@ def add_new_solutions(
 
     logger.info(f"Found {len(submitted_ids)} submissions")
 
+    # Rate limits:
+    #   1. Users must wait MIN_WAIT_TIME_PER_USER_HRS hours between submissions.
+    #   2. No more than MAX_SUBMISSIONS_PER_WINDOW submissions RATE_LIMIT_WINDOW_HRS hours overall.
+
     sub_df = pd.DataFrame.from_dict(
         {
             "submission_id": submitted_ids,
-            "user_id": map(submission_id_to_user_id, submitted_ids),
-            "timestamp": map(submission_id_to_timestamp, submitted_ids),
+            "user_id": map(_submission_id_to_user_id, submitted_ids),
+            "timestamp": map(_submission_id_to_timestamp, submitted_ids),
         }
     )
 
+    # Per user limit
     now = datetime.now(timezone.utc)
     cutoff_user = now - timedelta(hours=MIN_WAIT_TIME_PER_USER_HRS)
     user_last_submission_ts = sub_df[sub_df.user_id == user_id].timestamp.max()
@@ -66,6 +67,7 @@ def add_new_solutions(
             f"Remaining wait time: {remaining_hrs:.2f} hours"
         )
 
+    # Overall limit
     cutoff_overall = now - timedelta(hours=RATE_LIMIT_WINDOW_HRS)
     if len(sub_df.timestamp > cutoff_overall) >= MAX_SUBMISSIONS_PER_WINDOW:
         logger.info(
@@ -174,14 +176,14 @@ def _validate_all_submissions_present(
         return ValueError("Duplicate problem IDs exist in uploaded file")
 
 
-def submission_id_to_user_id(submission_id: str) -> str:
+def _submission_id_to_user_id(submission_id: str) -> str:
     """
     Extracts the user ID from the submission ID: "YYYYMMDD_HHMMSS_username_userid"
     """
     return submission_id.rsplit("_", 1)[-1]
 
 
-def submission_id_to_timestamp(submission_id: str) -> datetime:
+def _submission_id_to_timestamp(submission_id: str) -> datetime:
     """
     Extracts the timestamp from the submission ID: "YYYYMMDD_HHMMSS_username_userid"
     """