Merge pull request #2358 from mashehu/add-markdown-to-modules-template

Add markdown hint to modules template
nf-core · Jun 30, 2023 · ffd8f64 · ffd8f64
2 parents 602e858 + 7c62700
commit ffd8f64
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git 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 ([#2358](https://github.com/nf-core/tools/pull/2358))
 
 ### Download
 

diff --git 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
@@ -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