Merge pull request #3055 from mashehu/update-file-name

template: Use filename in code block for `params.yml`
nf-core · Jul 9, 2024 · 370512f · 370512f
2 parents ecfe0fb + c22888a
commit 370512f
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,7 @@
 - Change paths to test data ([#2985](https://github.com/nf-core/tools/pull/2985))
 - Run awsfulltest on PRs to `master` with two PR approvals ([#3042](https://github.com/nf-core/tools/pull/3042))
 - Remove deprecated syntax ([#3046](https://github.com/nf-core/tools/pull/3046))
+- Use filename in code block for `params.yml` ([#3055](https://github.com/nf-core/tools/pull/3055))
 
 ### Linting
 

diff --git a/nf_core/pipeline-template/docs/usage.md b/nf_core/pipeline-template/docs/usage.md
@@ -89,9 +89,9 @@ The above pipeline run specified with a params file in yaml format:
 nextflow run {{ name }} -profile docker -params-file params.yaml
 ```
 
-with `params.yaml` containing:
+with:
 
-```yaml
+```yaml title="params.yaml"
 input: './samplesheet.csv'
 outdir: './results/'
 genome: 'GRCh37'