Skip to content

Conversation

christopher-hakkaart
Copy link
Collaborator

@christopher-hakkaart christopher-hakkaart commented Jul 21, 2025

This pull request improves the documentation in docs/cache-and-resume.md by restructuring the section on cache failures, providing clearer explanations, and adding examples to help users troubleshoot common issues. The most important changes include reorganizing the causes of cache failures into subsections, enhancing clarity with examples, and offering solutions for resolving specific failure types.

Improvements to documentation structure and clarity:

  • Reorganized the "Cache Failures" section by grouping causes into subsections, such as "Resume not enabled," "Non-default cache directives," and "Modified input files," for better readability.
  • Added detailed explanations and examples for each failure type, such as how to enable -resume, handle non-default cache directives, and avoid modifying input files.

Examples and solutions for specific failure types:

  • Provided examples and solutions for handling race conditions caused by global variables, including using local variables or avoiding variables entirely.
  • Clarified the behavior of non-deterministic process inputs and added a solution to join channels explicitly before invoking a process.

Signed-off-by: Christopher Hakkaart <[email protected]>
@christopher-hakkaart christopher-hakkaart requested a review from a team as a code owner July 21, 2025 07:22
Copy link

netlify bot commented Jul 21, 2025

Deploy Preview for nextflow-docs-staging ready!

Name Link
🔨 Latest commit f96b103
🔍 Latest deploy log https://app.netlify.com/projects/nextflow-docs-staging/deploys/687f073da843740008238db1
😎 Deploy Preview https://deploy-preview-6292--nextflow-docs-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@pditommaso pditommaso merged commit a5f8d9b into nextflow-io:master Jul 22, 2025
9 of 10 checks passed
@bentsherman
Copy link
Member

@pditommaso please do not merge significant docs PRs without allowing me to review. I had to make several corrections in #6299

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants