nf-core tools documentation is incomplete
Open
Nobody has claimed this yet.
bug
- Dominant language
- MDX
- Stars
- 98
- Forks
- 298
- Avg merge
- 14h 38m
- Merged PRs (30d)
- 38
Description
Describe the bug
https://nf-co.re/docs/nf-core-tools/ does not show patch as a subtools applicable to subworkflows, even though it does appear in the helptext when running nf-core subworkflows
To Reproduce
- Run
nf-core subworkflows - Compare to https://nf-co.re/docs/nf-core-tools/
Expected behavior
All available options should be documented in the documentation.
Browser (please complete the following information):
- OS: OSX 15.4 Sequoia (24E248)
- Browser Chrome
- Version 137.0.7151.120
Additional context
Add any other context about the problem here.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the nf-core tools documentation at https://nf-co.re/docs/nf-core-tools/ and compare it with the output of nf-core subworkflows. Document the missing patch subtool and verify that the page lists all options shown by the command.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100