diff --git a/sites/docs/src/content/api_reference/3.0.0/api/pipelines/create.md b/sites/docs/src/content/api_reference/3.0.0/api/pipelines/create.md index 4ad696258c..faa91304cb 100644 --- a/sites/docs/src/content/api_reference/3.0.0/api/pipelines/create.md +++ b/sites/docs/src/content/api_reference/3.0.0/api/pipelines/create.md @@ -33,7 +33,7 @@ See also \[the Screen.SUB_TITLE attribute]\[textual.screen.Screen.SUB_TITLE]. #### `TEMPLATE_CONFIG{:python}`_= CreateConfig(org=None, name=None, description=None, author=None, version=None, force=True, outdir=None, skip_features=None, is_nfcore=None)_ -#### `TITLE{:python}`_: str | None_ _= 'nf-core create'_ +#### `TITLE{:python}`_: str | None_ _= 'nf-core pipelines create'_ A class variable to set the _default_ title for the application. diff --git a/sites/docs/src/content/api_reference/3.0.1/api/pipelines/create.md b/sites/docs/src/content/api_reference/3.0.1/api/pipelines/create.md index 4ad696258c..faa91304cb 100644 --- a/sites/docs/src/content/api_reference/3.0.1/api/pipelines/create.md +++ b/sites/docs/src/content/api_reference/3.0.1/api/pipelines/create.md @@ -33,7 +33,7 @@ See also \[the Screen.SUB_TITLE attribute]\[textual.screen.Screen.SUB_TITLE]. #### `TEMPLATE_CONFIG{:python}`_= CreateConfig(org=None, name=None, description=None, author=None, version=None, force=True, outdir=None, skip_features=None, is_nfcore=None)_ -#### `TITLE{:python}`_: str | None_ _= 'nf-core create'_ +#### `TITLE{:python}`_: str | None_ _= 'nf-core pipelines create'_ A class variable to set the _default_ title for the application. diff --git a/sites/docs/src/content/api_reference/3.0.1/pipeline_lint_tests/template_strings.md b/sites/docs/src/content/api_reference/3.0.1/pipeline_lint_tests/template_strings.md index 37b9794794..364674d06f 100644 --- a/sites/docs/src/content/api_reference/3.0.1/pipeline_lint_tests/template_strings.md +++ b/sites/docs/src/content/api_reference/3.0.1/pipeline_lint_tests/template_strings.md @@ -4,7 +4,7 @@ Check for template placeholders. -The `nf-core create` pipeline template uses +The `nf-core pipelines create` pipeline template uses [Jinja](https://jinja.palletsprojects.com/en/2.11.x/) behind the scenes. This lint test fails if any Jinja template variables such as diff --git a/sites/docs/src/content/docs/nf-core-tools/CLI/pipelines/lint.md b/sites/docs/src/content/docs/nf-core-tools/CLI/pipelines/lint.md index 07d3b1baef..db97b2a320 100644 --- a/sites/docs/src/content/docs/nf-core-tools/CLI/pipelines/lint.md +++ b/sites/docs/src/content/docs/nf-core-tools/CLI/pipelines/lint.md @@ -15,7 +15,7 @@ timeout: 60 working_dir: tmp/nf-core-nextbigthing before_command: > echo "lint: { pipeline_todos: false }" >> .nf-core.yml -fake_command: nf-core lint +fake_command: nf-core pipelines lint --> ![`nf-core pipelines lint`](../../../../../assets/images/tools/nf-core-lint.svg) diff --git a/sites/docs/src/content/docs/nf-core-tools/CLI/pipelines/schema.md b/sites/docs/src/content/docs/nf-core-tools/CLI/pipelines/schema.md index 59e7c91275..9d4d90edc6 100644 --- a/sites/docs/src/content/docs/nf-core-tools/CLI/pipelines/schema.md +++ b/sites/docs/src/content/docs/nf-core-tools/CLI/pipelines/schema.md @@ -9,7 +9,7 @@ nf-core pipelines have a `nextflow_schema.json` file in their root that describe These files enable automated input validation, generate command line help, and build interfaces to launch pipelines. Pipeline schema files follow the [JSONSchema specification](https://json-schema.org/) (Draft 7). -To help developers working with pipeline schema, nf-core tools has three `schema` sub-commands: +To help developers working with pipeline schema, nf-core tools has four `schema` sub-commands: - `nf-core pipelines schema validate` - `nf-core pipelines schema build` @@ -36,14 +36,14 @@ The `pipeline` option can be a directory containing a pipeline, a path to a sche ## Build a pipeline schema -Manually building JSONSchema documents is complex and error prone. +Manually building JSONSchema documents is complex and error-prone. The `nf-core pipelines schema build` command collects your pipeline parameters and provides interactive prompts about any missing or unexpected parameters. If no schema exists, it will create one for you. Once built, the tool can send the schema to the nf-core website where you can use a graphical interface to organise and fill in the schema. The tool checks your schema status on the website and saves your changes locally once complete. -Run `nf-core schema build -d `, for example: +Run `nf-core pipelines schema build -d `, for example: