nf-core / nft-utils

nf-test utility functions
MIT License
9 stars 7 forks source link

Improve user eligibility for getAllFilesInDir() docs #24

Closed jfy133 closed 1 month ago

jfy133 commented 1 month ago

@TCLamnidis and I had big troubles trying to understand the documentation for the getAllFilesInDir() function, as it seemed to be more written from a programmer PoV rather than a user point of view (ordering seemed to assume prior knowledge).

We've written the docs for that function make it more accessible for a user coming in wanting to use it, namely:

  1. Describe what it does
  2. Describing the parameter of teh functions (how to use it 'quick reference')
  3. And then better describe the example