Hey folks. What do you think is the appropriate ac...
# team-maintainers
m
Hey folks. What do you think is the appropriate action with respect to the test when adding a deprecation message (since the assertion will cause a failure)? Current guidelines: https://nf-co.re/docs/guidelines/components/module_deprecation We need to add what to do about the test which will fail. https://nfcore.slack.com/archives/CJRH30T6V/p1744369780278919?thread_ts=1744366788.146159&cid=CJRH30T6V
l
I've added a simple nf-test and ensure that it is failling. But maybe we should update the guidelines to have a bit more information about this case.
s
I thought that the deprecation assert is ignored in the nf-test? But I don't think we need to make tests for modules that are deprecated to be honest
l
It's just that the linting would complain for the absence of a nf-test file.
s
ok, the one you've added with a process.failed is perfect
which has the test and snap still, but commented out
l
I don't know which options should be prefered. • If you comment everything out you save computational resources • If you run a nf-test with a failed assertion, it does check the deprecation
s
The benefit of a commented out test is it shows how the module is actually used, but given that we're saying you shouldn't use it anyway that is probably not a great benefit
I'm happy with the failed assertion, that seems sensible