update noun phrase for derived task IDs

This will fix #186 see also hubverse-org/hubDocs#222
hubverse-org · Jan 2, 2025 · 00db9c5 · 00db9c5
1 parent def750c
commit 00db9c5
Show file tree

Hide file tree

Showing 10 changed files with 34 additions and 34 deletions.
diff --git a/R/check_tbl_values_required.R b/R/check_tbl_values_required.R
@@ -7,7 +7,7 @@
 #' @export
 #' @details
 #' Note that it is **necessary for `derived_task_ids` to be specified if any of
-#' the task IDs a derived task ID depends on have required values**. If this is the
+#' the task IDs with `required` values have dependent derived task IDs**. If this is the
 #' case and derived task IDs are not specified, the dependent nature of derived
 #' task ID values will result in **false validation errors when validating
 #' required values**.

diff --git a/R/validate_model_data.R b/R/validate_model_data.R
@@ -12,11 +12,11 @@
 #' @inherit validate_model_file return
 #' @export
 #' @details
-#' Note that it is **necessary for `derived_task_ids` to be specified if any of
-#' the task IDs a derived task ID depends on have required values**. If this is the
-#' case and derived task IDs are not specified, the dependent nature of derived
-#' task ID values will result in **false validation errors when validating
-#' required values**.
+#' Note that it is **necessary for `derived_task_ids` to be specified if any
+#' task IDs with `required` values have dependent derived task IDs**. If this
+#' is the case and derived task IDs are not specified, the dependent nature of
+#' derived task ID values will result in **false validation errors when
+#' validating required values**.
 #'
 #' Details of checks performed by `validate_model_data()`
 #'

diff --git a/R/validate_pr.R b/R/validate_pr.R
@@ -50,11 +50,11 @@
 #' determined relative to a reference date and not when explicit submission
 #' window start and end dates are provided in the config.
 #'
-#' Finally, note that it is **necessary for `derived_task_ids` to be specified if any of
-#' the task IDs a derived task ID depends on have required values**. If this is the
-#' case and derived task IDs are not specified, the dependent nature of derived
-#' task ID values will result in **false validation errors when validating
-#' required values**.
+#' Finally, note that it is **necessary for `derived_task_ids` to be specified if any
+#' task IDs with `required` values have dependent derived task IDs**. If this
+#' is the case and derived task IDs are not specified, the dependent nature of
+#' derived task ID values will result in **false validation errors when
+#' validating required values**.
 #'
 #' ### Checks on model output files
 #'

diff --git a/R/validate_submission.R b/R/validate_submission.R
@@ -20,11 +20,11 @@
 #' provided in the hub's config.
 #' @export
 #' @details
-#' Note that it is **necessary for `derived_task_ids` to be specified if any of
-#' the task IDs a derived task ID depends on have required values**. If this is the
-#' case and derived task IDs are not specified, the dependent nature of derived
-#' task ID values will result in **false validation errors when validating
-#' required values**.
+#' Note that it is **necessary for `derived_task_ids` to be specified if any
+#' task IDs with `required` values have dependent derived task IDs**. If this
+#' is the case and derived task IDs are not specified, the dependent nature of
+#' derived task ID values will result in **false validation errors when
+#' validating required values**.
 #'
 #' Details of checks performed by `validate_submission()`
 #'

diff --git a/man/check_tbl_values_required.Rd b/man/check_tbl_values_required.Rd
diff --git a/man/validate_model_data.Rd b/man/validate_model_data.Rd
diff --git a/man/validate_pr.Rd b/man/validate_pr.Rd
diff --git a/man/validate_submission.Rd b/man/validate_submission.Rd
diff --git a/vignettes/articles/validate-pr.Rmd b/vignettes/articles/validate-pr.Rmd
@@ -68,7 +68,7 @@ With standard validation, derived task IDs like `target_end_date` tend to pollut
 
 <div class="alert alert-warning" role="alert">
 
-Note that, **if any of the task IDs a derived task ID depends on have required values, it is essential for `derived_task_ids` to be specified**. 
+Note that, **if any task IDs with `required` values have dependent derived task IDs, it is essential for `derived_task_ids` to be specified**. 
 If this is the case and derived task IDs are not specified, the dependent nature of derived task ID values will result in **false validation errors when validating required values**.
 
 </div>

diff --git a/vignettes/articles/validate-submission.Rmd b/vignettes/articles/validate-submission.Rmd
@@ -107,7 +107,7 @@ Depending on config complexity, this **can often lead to a significant improveme
 
 <div class="alert alert-warning" role="alert">
 
-Note that, **if any of the task IDs a derived task ID depends on have required values, it is essential for `derived_task_ids` to be specified**. 
+Note that, **if any task IDs with `required` values have dependent derived task IDs, it is essential for `derived_task_ids` to be specified**. 
 If this is the case and derived task IDs are not specified, the dependent nature of derived task ID values will result in **false validation errors when validating required values**.
 
 If you're unsure if this is the case for your hub or which task IDs are derived, please consult the hub documentation or contact the hub administrators.