-
Notifications
You must be signed in to change notification settings - Fork 194
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
Document ext.args in meta yml #3451
base: dev
Are you sure you want to change the base?
Conversation
This PR is against the
|
Codecov ReportAttention: Patch coverage is
Additional details and impacted files☔ View full report in Codecov by Sentry. |
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.
Looking good!
We could automatically add all the args to the meta.yml
when running nf-core modules lint --fix
, this is done by update_meta_yml_file()
function in nf_core/modules/lint/__init__.py
. Then we can gradually keep adding the change to modules, so we don't have to do a big bulk update PR, especially since this will be a warning, not an error.
I am also working on some modifications to the meta.yml here, these shouldn't affect your changes, but it would be good if we can avoid big merge conflicts.
This closes #3444
An analogous PR to nf-core/modules will need to be made to update the module meta yml schema json if this is approved.
This PR adds:
ext.args
info frommeta.yml
displayed bymodules info
ext.args*
are not documented inmeta.yml
Will need to add a test for this lint check/info output but not sure how best to achieve this before an update to nf-core/modules?
PR checklist
CHANGELOG.md
is updateddocs
is updated