`getAllFilesFromDir()` examples are confusing due to incomaptibliity of `*.name` pattern and `relative: true`
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 13
- Forks
- 11
- Avg merge
- 1d 16h
- Merged PRs (30d)
- 6
Description
The docs here: https://github.com/nf-core/nft-utils/blob/main/docs/usage.md#getallfilesfromdir
Say to use *.name to get the names of all files when recording just file names.
However if you add relative: true as an option, this doesn't work as you get an groovy.lang.MissingPropertyException: No such property: name for class: java.lang.String error.,
This makes sense I guess as you are not returning a relative path, but a string.
However this should be documented that this new relative option is NOT compatible with the *.name pattern; or to remove the recommandtion of using *name.
Contributor guide
No contributing guide indexed for this repository
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 getAllFilesFromDir section in docs/usage.md and compare the *.name example with the relative: true option described in the issue. Update the documentation to explain their incompatibility or remove the conflicting recommendation; done means the example no longer suggests a combination that raises the reported error.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- groovy
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100