Skip to content

Commit 378c682

Browse files
nvnieuwkjmuhlich
andauthored
Update docs/parameters/help_text.md
Co-authored-by: Jeremy Muhlich <[email protected]>
1 parent c0caaa5 commit 378c682

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/parameters/help_text.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ If you prefer, you can disable these by setting the `validation.monochromeLogs`
168168
This function returns a help message with the command to run a pipeline and the available parameters.
169169
Pass it to `log.info` to print in the terminal.
170170

171-
The function takes one optional positional argument, which can be a parameter name to get the help message for. Additionally, it can take a couple of options to customize the help message:
171+
The function takes one optional positional argument, which can be a parameter name to get the help message for. Additionally, it accepts the following options to customize the help message:
172172

173173
- `parametersSchema`: Path to the JSON schema to get the help message from. Defaults to the schema defined in the `validation.parametersSchema` configuration option (which is `nextflow_schema.json` by default).
174174
- `beforeText`: Text to print before the help message. Defaults to the `validation.help.beforeText` configuration option.

0 commit comments

Comments
 (0)