docs: Add longer NXF_SYNTAX_PARSER descriptions#6637
docs: Add longer NXF_SYNTAX_PARSER descriptions#6637christopher-hakkaart merged 4 commits intonextflow-io:masterfrom
Conversation
Signed-off-by: Christopher Hakkaart <chris.hakkaart@seqera.io>
✅ Deploy Preview for nextflow-docs-staging ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Signed-off-by: Christopher Hakkaart <chris.hakkaart@seqera.io>
Signed-off-by: Christopher Hakkaart <chris.hakkaart@seqera.io>
bentsherman
left a comment
There was a problem hiding this comment.
Please address these comments in a new PR
|
|
||
| <h3>Workflow params</h3> | ||
|
|
||
| :::note |
| <h3>Workflow params</h3> | ||
|
|
||
| :::note | ||
| To use workflow params, set the `NXF_SYNTAX_PARSER` environment variable to `v2`: |
There was a problem hiding this comment.
The wording kinda suggests that this is all you need to do in order to use workflow params, maybe better to phrase it the same way that you did in workflow.md
There was a problem hiding this comment.
Also this note needs to be added to "Type annotations" and "New syntax for workflow handlers"
| In order to use this feature, you'll need to: | ||
| To use this feature: | ||
|
|
||
| 1. Set the `NXF_SYNTAX_PARSER` environment variable to `v2`: |
There was a problem hiding this comment.
I would still phrase it as "Enable the strict syntax by setting..." so that there is a link to the strict syntax. Enabling this flag in practice will require other changes to pipeline code which are explained on that page
| export NXF_SYNTAX_PARSER=v2 | ||
| ``` | ||
|
|
||
| Without this environment variable set, Nextflow will not enforce strict syntax rules. Add this to your shell profile (e.g., `~/.bashrc`, `~/.zshrc`) or set it before you run Nextflow commands. |
There was a problem hiding this comment.
I'm not sure we should recommend setting this flag globally, although it may be sensible for some. I suspect most people will need to toggle it at a pipeline-level for the time being.
No description provided.