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

Update process snippets to comply with strict syntax #5526

Merged
merged 2 commits into from
Nov 21, 2024

Conversation

bentsherman
Copy link
Member

The strict syntax is a bit more picky about the process script: section label (source):

The Nextflow language specification allows the script: label to be omitted only if there are no other sections

This PR updates process snippets throughout the docs to comply with this rule.

@bentsherman bentsherman requested a review from a team as a code owner November 19, 2024 21:13
@bentsherman bentsherman requested review from pditommaso and removed request for a team November 19, 2024 21:13
Copy link

netlify bot commented Nov 19, 2024

Deploy Preview for nextflow-docs-staging ready!

Name Link
🔨 Latest commit 4730bee
🔍 Latest deploy log https://app.netlify.com/sites/nextflow-docs-staging/deploys/673dfaacab95d80008a92394
😎 Deploy Preview https://deploy-preview-5526--nextflow-docs-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@christopher-hakkaart
Copy link
Contributor

Adding script: looks good to me. It does make the the """ vs ''' more noticeable in examples. What do you think about standardizing these as """ (unless single quotes are required)?

@bentsherman
Copy link
Member Author

The rules around single vs double quotes:

  • if you need to reference a Nextflow variable, you must use double quotes
  • otherwise, if you need to reference a Bash variable, it's easier to use single quotes so that you don't have to escape the dollar sign
  • otherwise, it doesn't matter

I have updated the process scripts to be more consistent, i.e. use double quotes except where it's cleaner to use single quotes

@pditommaso pditommaso merged commit be1694b into master Nov 21, 2024
11 checks passed
@pditommaso pditommaso deleted the docs-process-snippets-syntax branch November 21, 2024 06:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants