Skip to content

Emphasise base.config values SHOULD be adjusted on a per-pipeline basis by developer#4360

Open
jfy133 wants to merge 1 commit into
devfrom
make-clearer-to-update-baseconfig
Open

Emphasise base.config values SHOULD be adjusted on a per-pipeline basis by developer#4360
jfy133 wants to merge 1 commit into
devfrom
make-clearer-to-update-baseconfig

Conversation

@jfy133

@jfy133 jfy133 commented Jun 30, 2026

Copy link
Copy Markdown
Member

Updated TODO comments to clarify resource adjustments for the pipeline.

PR checklist

  • This comment contains a description of changes (with reason)
  • CHANGELOG.md is updated
  • If you've fixed a bug or added code that should be tested, add tests!
  • Documentation in docs is updated

Updated TODO comments to clarify resource adjustments for the pipeline.
@codecov

codecov Bot commented Jun 30, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.07%. Comparing base (fd52c20) to head (1d2252d).

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

// adding in your local modules too.
// TODO nf-core: Customise requirements for specific processes.
// See https://www.nextflow.io/docs/latest/config.html#config-process-selectors
// TODO nf-core: adjust all CPU, memory, and time resource requests to work with 'average' data for the pipeline

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add stronger language:

// TODO nf-core: adjust all CPU, memory, and time resource requests to work with 'average' data for the pipeline
//        Default resource usage limits are intentionally generous and are may not be suitable. 
//        It is highly recommended to modify these settings to suit your pipeline.

// adding in your local modules too.
// TODO nf-core: Customise requirements for specific processes.
// See https://www.nextflow.io/docs/latest/config.html#config-process-selectors
// TODO nf-core: adjust all CPU, memory, and time resource requests to work with 'average' data for the pipeline

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// TODO nf-core: adjust all CPU, memory, and time resource requests to work with 'average' data for the pipeline
// TODO nf-core: adjust all CPU, memory, and time resource requests to work with 'average' data for the pipeline
// Default resource usage limits are intentionally generous and are may not be suitable.
// It is highly recommended to modify these settings to suit your pipeline.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants