Skip to content
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

feat(subworkflows): rename utils_nfvalidation_plugin to utils_validate_params #5513

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

maxulysse
Copy link
Member

Name is more future proof with the coming nf-validation to nf-schema release

PR checklist

Closes #XXX

  • This comment contains a description of changes (with reason).
  • If you've fixed a bug or added code that should be tested, add tests!
  • If you've added a new tool - have you followed the module conventions in the contribution docs
  • If necessary, include test data in your PR.
  • Remove all TODO statements.
  • Emit the versions.yml file.
  • Follow the naming conventions.
  • Follow the parameters requirements.
  • Follow the input/output options guidelines.
  • Add a resource label
  • Use BioConda and BioContainers if possible to fulfil software requirements.
  • Ensure that the test works with either Docker / Singularity. Conda CI tests can be quite flaky:
    • For modules:
      • nf-core modules test <MODULE> --profile docker
      • nf-core modules test <MODULE> --profile singularity
      • nf-core modules test <MODULE> --profile conda
    • For subworkflows:
      • nf-core subworkflows test <SUBWORKFLOW> --profile docker
      • nf-core subworkflows test <SUBWORKFLOW> --profile singularity
      • nf-core subworkflows test <SUBWORKFLOW> --profile conda

@maxulysse maxulysse requested a review from a team as a code owner April 22, 2024 09:23
@maxulysse maxulysse requested review from vagkaratzas and removed request for a team April 22, 2024 09:23
Copy link
Contributor

@adamrtalbot adamrtalbot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personally, I like this more. It says what the subworkflow does and not what it is, which is way easier to understand.

I think a name is a part of the API, therefore it should remain static while the internals freely change.

But I'd like someone else's opinion!

Copy link
Contributor

@SPPearce SPPearce left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this utils_utils_validate_params not just utils_validate_params?

@maxulysse maxulysse changed the title feat(subworkflows): rename utils_nfvalidation_plugin to utils_utils_validate_params feat(subworkflows): rename utils_nfvalidation_plugin to utils_validate_params Apr 22, 2024
@maxulysse
Copy link
Member Author

Why is this utils_utils_validate_params not just utils_validate_params?

That was a typo, sorry about that...
🤦

@SPPearce
Copy link
Contributor

Are we happy with the name?

@mashehu
Copy link
Contributor

mashehu commented Apr 30, 2024

this was in the template for a bit. can we wait until we have some functionality in tools to handle a rename gracefully?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

None yet

4 participants