-
Notifications
You must be signed in to change notification settings - Fork 16
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.
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
[Improvement][WIP] Add subworkflow documentation #55
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very nice work , all the content seems to be there ! I will try the steps to create a module before Thursday and get back to you. I would however like a slight reshoot over the text. There is a lot of verb tenses that switch throughout, that also make you switch subject a lot.
For example, you start with imperative
tense at line 5, then switch at line 22. I would refrain using we
altogether, and use only imperative
and impersonal
statements. It would make the tutorial flow better and look more like a list of steps to follow.
As for the tests documentation, I'll do a shot on that with Anthony on another PR, where he'll document nf-test. It'll go in another documentation file, we need to move some common things from MODULES.md as well. I'll work the PR and get back to you on how we integrate it here.
…il; branch 'main' of github.com:scilus/nf-scil into doc_subworkflows
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's going on well. A few comments, then I think it'll be good to go ! We'll merge without the nf-test
documentation inserted and add it in another PR, with the help of @gagnonanthony and some changes I have made to the remaining doc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Last round of suggestions, then we should done with this one !
This is all good for me ! I'll let @gagnonanthony and @Manonedde go through one time and validate with their experience building wokrflows. Then, LGTM ! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work! I made minor suggestions, but other than that, very nice! 💯
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM ! 🍻
GJ @ThoumyreStanislas 🥳 |
Describe your changes
Say which test data are used by your module
Checklist before requesting a review
./modules/nf-scil/<category>/<tool>/main.nf
./modules/nf-scil/<category>/<tool>/meta.yml
./tests/modules/nf-scil/<category>/<tool>/main.nf
./tests/modules/nf-scil/<category>/<tool>/nextflow.config