Link to other docs on the failOnIgnore option (#5122) [ci skip]

Signed-off-by: James A. Fellows Yates <jfy133@gmail.com> Co-authored-by: Adam Talbot <12817534+adamrtalbot@users.noreply.github.com>
nextflow-io · Jul 10, 2024 · 572f211 · 572f211
1 parent e72ff74
commit 572f211
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/docs/metadata.md b/docs/metadata.md
@@ -63,6 +63,8 @@ The following table lists the properties that can be accessed on the `workflow`
   :::
 : Whether the `workflow.failOnIgnore` config option was enabled.
 
+: See {ref}`process-error-strategy` for use-cases of this option.
+
 `workflow.fusion.enabled`
 : Whether Fusion is enabled.
 

diff --git a/docs/process.md b/docs/process.md
@@ -1691,6 +1691,8 @@ To illustrate the differences between error strategies, consider the following e
 - **errorStrategy `finish`**: Nextflow will allow any other existing tasks to conclude (but not submit any more) and report an error.
 - **errorStrategy `ignore`**: Nextflow will continue submitting tasks for the remaining 95 samples, complete the workflow, and report a successful pipeline completion.
 - **errorStrategy `ignore` and `workflow.failOnIgnore` set to `true` in configuration**: The same behavior as setting the errorStrategy alone, except the pipeline will return an exit status of -1 and report an error.
+
+See {ref}`metadata-workflow` for more information on `workflow.failOnIgnore`.
 :::
 
 The `retry` error strategy allows you to re-submit for execution a process returning an error condition. For example: