Clarify ref_date_from docs

R/check_submission_time.R

@@ -1,10 +1,13 @@
 #' Checks submission is within the valid submission window for a given round.
 #'
-#' @param ref_date_from whether to get the round ID around which relative submission
-#' windows will be determined from the file's `file_path` or the `file` contents
-#' themselves. `file` requires that the file can be read.
+#' @param ref_date_from whether to get the reference date around
+#' which relative submission windows will be determined from the file's
+#' `file_path` round ID or the `file` contents themselves.
+#' `file` requires that the file can be read.
 #' Only applicable when a round is configured to determine the submission
 #' windows relative to the value in a date column in model output files.
+#' Not applicable when explicit submission window start and end dates are
+#' provided in the hub's config.
 #'
 #' @inherit check_tbl_col_types params return
 #'

R/validate_pr.R

@@ -39,10 +39,10 @@
 #'
 #' Note that to establish **relative** submission windows when performing
 #' modification/deletion checks and `allow_submit_window_mods`
-#' is `TRUE`, the _relative to_ date is considered as the `round_id` extracted from
+#' is `TRUE`, the reference date is taken as the `round_id` extracted from
 #' the file path (i.e. `submit_window_ref_date_from` is always set to `"file_path"`).
 #' This is because we cannot extract dates from columns of deleted
-#' files. If hub _relative to_ dates do not match the round IDs in file paths,
+#' files. If hub submission window reference dates do not match round IDs in file paths,
 #' currently `allow_submit_window_mods` will not work correctly and is best set
 #' to `FALSE`. This only relates to hubs/rounds where submission windows are
 #' determined relative to a reference date and not when explicit submission

R/validate_submission.R

@@ -6,11 +6,14 @@
 #' @param skip_submit_window_check Logical. Whether to skip the submission window check.
 #' @param skip_check_config Logical. Whether to skip the hub config validation check.
 #'  check.
-#' @param submit_window_ref_date_from whether to get the round ID around which relative submission
-#' windows will be determined from the file's `file_path` or the `file` contents
-#' themselves. `file` requires that the file can be read.
+#' @param submit_window_ref_date_from whether to get the reference date around
+#' which relative submission windows will be determined from the file's
+#' `file_path` round ID or the `file` contents themselves.
+#' `file` requires that the file can be read.
 #' Only applicable when a round is configured to determine the submission
 #' windows relative to the value in a date column in model output files.
+#' Not applicable when explicit submission window start and end dates are
+#' provided in the hub's config.
 #' @export
 #'
 #' @examples