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

Fix large comment block headers so they don't cause phantom merge con… #6755

Merged
merged 3 commits into from
Oct 9, 2024

Conversation

jfy133
Copy link
Member

@jfy133 jfy133 commented Oct 8, 2024

…flicts

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

@jfy133 jfy133 added this pull request to the merge queue Oct 8, 2024
@mashehu mashehu removed this pull request from the merge queue due to a manual request Oct 8, 2024
@mashehu
Copy link
Contributor

mashehu commented Oct 8, 2024

wait, you removed the harshil alignment 😱
please put it back

@jfy133
Copy link
Member Author

jfy133 commented Oct 8, 2024

wait, you removed the harshil alignment 😱 please put it back

Ben made me do it though 👀

What do I do 😱

@mashehu
Copy link
Contributor

mashehu commented Oct 8, 2024

I thought ben's secret thing followed harshil alignment. in any case in nf-core harshil alignment > ben

@jfy133
Copy link
Member Author

jfy133 commented Oct 8, 2024

No apparnetluy not everywhere...

I guess I'll go start from scratch then... 😢

Copy link
Member

@mirpedrol mirpedrol left a comment

Choose a reason for hiding this comment

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

I added the Harshil alignment back with these suggestions

subworkflows/nf-core/utils_nextflow_pipeline/main.nf Outdated Show resolved Hide resolved
subworkflows/nf-core/utils_nfcore_pipeline/main.nf Outdated Show resolved Hide resolved
subworkflows/nf-core/utils_nfcore_pipeline/main.nf Outdated Show resolved Hide resolved
subworkflows/nf-core/utils_nfcore_pipeline/main.nf Outdated Show resolved Hide resolved
subworkflows/nf-core/utils_nfcore_pipeline/main.nf Outdated Show resolved Hide resolved
subworkflows/nf-core/utils_nfcore_pipeline/main.nf Outdated Show resolved Hide resolved
subworkflows/nf-core/utils_nfcore_pipeline/main.nf Outdated Show resolved Hide resolved
subworkflows/nf-core/utils_nfcore_pipeline/main.nf Outdated Show resolved Hide resolved
subworkflows/nf-core/utils_nfcore_pipeline/main.nf Outdated Show resolved Hide resolved
subworkflows/nf-core/utils_nfvalidation_plugin/main.nf Outdated Show resolved Hide resolved
@jfy133
Copy link
Member Author

jfy133 commented Oct 9, 2024

Thank you @mirpedrol !

@mirpedrol mirpedrol added this pull request to the merge queue Oct 9, 2024
Merged via the queue into master with commit 9d05360 Oct 9, 2024
30 checks passed
@mirpedrol mirpedrol deleted the fix-comment-header-blocks branch October 9, 2024 08:40
Comment on lines -114 to +120
log.warn "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n" +
" There is a problem with your Conda configuration!\n\n" +
" You will need to set-up the conda-forge and bioconda channels correctly.\n" +
" Please refer to https://bioconda.github.io/\n" +
" The observed channel order is \n" +
" ${channels}\n" +
" but the following channel order is required:\n" +
" ${required_channels_in_order}\n" +
"~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
log.warn(
"~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n" + " There is a problem with your Conda configuration!\n\n" + " You will need to set-up the conda-forge and bioconda channels correctly.\n" + " Please refer to https://bioconda.github.io/\n" + " The observed channel order is \n" + " ${channels}\n" + " but the following channel order is required:\n" + " ${required_channels_in_order}\n" + "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
)

Choose a reason for hiding this comment

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

I tried to preserve the formatting here but found it to be tricky, probably a multi-line string would be better anyway:

    log.warn """\
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
          There is a problem with your Conda configuration!

          You will need to set-up the conda-forge and bioconda channels correctly.
          Please refer to https://bioconda.github.io/
          The observed channel order is 
          ${channels}
          but the following channel order is required:
          ${required_channels_in_order}
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        """.stripIndent(true)

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

Successfully merging this pull request may close these issues.

4 participants