From efbe400110887c053acfcd2d023de2b7980d15a4 Mon Sep 17 00:00:00 2001 From: mashehu Date: Fri, 30 Jun 2023 15:36:06 +0200 Subject: [PATCH 1/3] add hint to use markdown in component channel description --- nf_core/module-template/modules/meta.yml | 4 ++-- nf_core/subworkflow-template/subworkflows/meta.yml | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/nf_core/module-template/modules/meta.yml b/nf_core/module-template/modules/meta.yml index 2c8197dcba..aea3c36aa3 100644 --- a/nf_core/module-template/modules/meta.yml +++ b/nf_core/module-template/modules/meta.yml @@ -30,7 +30,7 @@ input: type: map description: | Groovy Map containing sample information - e.g. [ id:'test', single_end:false ] + e.g. `[ id:'test', single_end:false ]` {% endif %} {% if not_empty_template -%} ## TODO nf-core: Delete / customise this example input @@ -49,7 +49,7 @@ output: type: map description: | Groovy Map containing sample information - e.g. [ id:'test', single_end:false ] + e.g. `[ id:'test', single_end:false ]` {% endif %} - versions: type: file diff --git a/nf_core/subworkflow-template/subworkflows/meta.yml b/nf_core/subworkflow-template/subworkflows/meta.yml index 4c5b454ddf..ae1689805d 100644 --- a/nf_core/subworkflow-template/subworkflows/meta.yml +++ b/nf_core/subworkflow-template/subworkflows/meta.yml @@ -17,7 +17,7 @@ input: type: map description: | Groovy Map containing sample information - e.g. [ id:'test' ] + e.g. `[ id:'test' ]` - bam: type: file description: BAM/CRAM/SAM file @@ -28,7 +28,7 @@ output: type: map description: | Groovy Map containing sample information - e.g. [ id:'test' ] + e.g. `[ id:'test' ]` - bam: type: file description: Sorted BAM/CRAM/SAM file From b70a034105f25f32c4ba00ac8aa95e567cc77dd0 Mon Sep 17 00:00:00 2001 From: mashehu Date: Fri, 30 Jun 2023 15:39:36 +0200 Subject: [PATCH 2/3] update changelog --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 77196dd428..d385fa0445 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -23,6 +23,7 @@ - Add functions to dynamically include pipeline tool citations in MultiQC methods description section for better reporting. ([#2326](https://github.com/nf-core/tools/pull/2326)) - Remove `--tracedir` parameter ([#2290](https://github.com/nf-core/tools/pull/2290)) - Incorrect config parameter warnings when customising pipeline template ([#2333](https://github.com/nf-core/tools/pull/2333)) +- Use markdown syntax in the description for the meta map channels ([#23585](https://github.com/nf-core/tools/pull/2358)) ### Download From 7c627003583935d90c173595ab8dd8229823deb9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Matthias=20H=C3=B6rtenhuber?= Date: Fri, 30 Jun 2023 15:51:31 +0200 Subject: [PATCH 3/3] Update CHANGELOG.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Júlia Mir Pedrol --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d385fa0445..6a55989925 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -23,7 +23,7 @@ - Add functions to dynamically include pipeline tool citations in MultiQC methods description section for better reporting. ([#2326](https://github.com/nf-core/tools/pull/2326)) - Remove `--tracedir` parameter ([#2290](https://github.com/nf-core/tools/pull/2290)) - Incorrect config parameter warnings when customising pipeline template ([#2333](https://github.com/nf-core/tools/pull/2333)) -- Use markdown syntax in the description for the meta map channels ([#23585](https://github.com/nf-core/tools/pull/2358)) +- Use markdown syntax in the description for the meta map channels ([#2358](https://github.com/nf-core/tools/pull/2358)) ### Download