Thanks to visit codestin.com
Credit goes to Github.com

Skip to content

Conversation

@RobJY
Copy link
Contributor

@RobJY RobJY commented Oct 31, 2024

I've made another pass or two through the documentation. It still needs work, but I'm starting a pull request so we can discuss.

This also adds a full test that can be run with:
nextflow run . -profile test_full,docker --outdir <OUTDIR>

PR checklist

  • This comment contains a description of changes (with reason).
  • If you've fixed a bug or added code that should be tested, add tests!
  • If you've added a new tool - have you followed the pipeline conventions in the contribution docs
  • If necessary, also make a PR on the nf-core/mcmicro branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core lint).
  • Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>).
  • Check for unexpected warnings in debug mode (nextflow run . -profile debug,test,docker --outdir <OUTDIR>).
  • Usage Documentation in docs/usage.md is updated.
  • Output Documentation in docs/output.md is updated.
  • CHANGELOG.md is updated.
  • README.md is updated (including new tool citations and authors/contributors).

Copy link
Member

@jmuhlich jmuhlich left a comment

Choose a reason for hiding this comment

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

Thanks, I'm sure this feels like a lot of unrewarding busywork but the docs are crucial.

@nf-core-bot
Copy link
Member

Warning

Newer version of the nf-core template is available.

Your pipeline is using an old version of the nf-core template: 3.0.2.
Please update your pipeline to the latest version.

For more documentation on how to update your pipeline, please see the nf-core documentation and Synchronisation documentation.

Co-authored-by: Jeremy Muhlich <[email protected]>
@RobJY RobJY self-assigned this Jan 6, 2025
@RobJY RobJY requested a review from jmuhlich January 6, 2025 20:54
@jmuhlich jmuhlich merged commit fda142c into nf-core:dev Jan 9, 2025
13 checks passed
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.

4 participants