Skip to content

fix: update docs on nf-test #3306

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

fix: update docs on nf-test #3306

wants to merge 5 commits into from

Conversation

famosab
Copy link
Contributor

@famosab famosab commented Apr 9, 2025 •
edited by nf-core-bot
Loading

@netlify /docs/tutorials/tests_and_test_data/nf-test_writing_tests

@netlify Netlify
Copy link

netlify bot commented Apr 9, 2025 •
edited
Loading

✅ Deploy Preview for nf-core-docs ready!

Name Link
🔨 Latest commit 8a238d8
🔍 Latest deploy log https://app.netlify.com/projects/nf-core-docs/deploys/68526db7c23b9a00081a0e60
😎 Deploy Preview https://deploy-preview-3306--nf-core-docs.netlify.app/docs/tutorials/tests_and_test_data/nf-test_writing_tests
📱 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.

@netlify Netlify
Copy link

netlify bot commented Apr 9, 2025 •
edited
Loading

✅ Deploy Preview for nf-core-main-site ready!

Name Link
🔨 Latest commit 8a238d8
🔍 Latest deploy log https://app.netlify.com/projects/nf-core-main-site/deploys/68526db8bbc7ce0008dee608
😎 Deploy Preview https://deploy-preview-3306--nf-core-main-site.netlify.app/docs/tutorials/tests_and_test_data/nf-test_writing_tests
📱 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.

maxulysse
maxulysse reviewed Apr 11, 2025
View reviewed changes
sites/docs/src/content/docs/tutorials/tests_and_test_data/nf-test_writing_tests.md
then {
assertAll(
{ assert process.success },
Copy link
Member

Choose a reason for hiding this comment

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

Can do as @SPPearce suggested and put the assert process.success before the assertAll?

Copy link
Contributor

Choose a reason for hiding this comment

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

I agree, this would be nice.
In the end do we even need the assertAll ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

not so sure about that either

@mashehu
Copy link
Contributor

mashehu commented Jun 9, 2025

any updates here @famosab?

@SPPearce
Copy link
Contributor

SPPearce commented Jun 9, 2025

I'm going to ping @LouisLeNezet here and hope that he is willing to do some work on the docs ;)

LouisLeNezet
LouisLeNezet reviewed Jun 9, 2025
View reviewed changes
Copy link
Contributor

@LouisLeNezet LouisLeNezet left a comment

Choose a reason for hiding this comment

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

Here is some comments, where things could be further standardized.
This would help to uniformize the modules repository 😉

sites/docs/src/content/docs/tutorials/tests_and_test_data/nf-test_writing_tests.md
then {
assertAll(
{ assert process.success },
Copy link
Contributor

Choose a reason for hiding this comment

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

I agree, this would be nice.
In the end do we even need the assertAll ?

famosab and others added 3 commits June 11, 2025 10:02
@famosab @LouisLeNezet
Apply suggestions from code review
3fd9793 
Co-authored-by: Louis Le Nézet <58640615+LouisLeNezet@users.noreply.github.com>
@mashehu
Merge branch 'main' into nf-test
885d5aa
@famosab @LouisLeNezet
Update sites/docs/src/content/docs/tutorials/tests_and_test_data/nf-t…
8a238d8 
…est_writing_tests.md

Co-authored-by: Louis Le Nézet <58640615+LouisLeNezet@users.noreply.github.com>
LouisLeNezet
LouisLeNezet reviewed Jun 18, 2025
View reviewed changes
sites/docs/src/content/docs/tutorials/tests_and_test_data/nf-test_writing_tests.md
process {
"""
input[0] = Channel.fromList([
tuple([ id:'test1', single_end:false ], // meta map
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we use tuple( or [

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I tend to remove everything even the Channel statetement

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

Reviewers

@maxulysse maxulysse maxulysse left review comments

@mashehu mashehu mashehu left review comments

@LouisLeNezet LouisLeNezet LouisLeNezet left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@famosab @mashehu @SPPearce @maxulysse @LouisLeNezet