demultiplex icon indicating copy to clipboard operation
demultiplex copied to clipboard
verified publisher icon nf-core

Escape angle brackets in output.md

Open k1sauce opened this issue 1 year ago • 1 comments

Some of the directory descriptions contain an angle bracket < which must be escaped in markdown. I have added the escape character.

PR checklist

  • [X ] This comment contains a description of changes (with reason).
  • [ ] If you've fixed a bug or added code that should be tested, add tests!
  • [ ] If you've added a new tool - have you followed the pipeline conventions in the contribution docs
  • [ ] If necessary, also make a PR on the nf-core/demultiplex branch on the nf-core/test-datasets repository.
  • [ ] Make sure your code lints (nf-core lint).
  • [ ] Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>).
  • [ ] Check for unexpected warnings in debug mode (nextflow run . -profile debug,test,docker --outdir <OUTDIR>).
  • [ ] Usage Documentation in docs/usage.md is updated.
  • [X ] Output Documentation in docs/output.md is updated.
  • [ ] CHANGELOG.md is updated.
  • [ ] README.md is updated (including new tool citations and authors/contributors).

k1sauce avatar Mar 07 '24 23:03 k1sauce

nf-core lint overall result: Failed :x:

Posted for pipeline commit 7b10f4b

+| ✅ 158 tests passed       |+
#| ❔   4 tests were ignored |#
!| ❗   5 tests had warnings |!
-| ❌   6 tests failed       |-

:x: Test failures:

:heavy_exclamation_mark: Test warnings:

  • files_exist - File not found: lib/WorkflowDemultiplex.groovy
  • nextflow_config - Config manifest.version should end in dev: 1.4.1
  • pipeline_todos - TODO string in README.md: Describe the minimum required steps to execute the pipeline, e.g. how to prepare samplesheets.
  • pipeline_todos - TODO string in awsfulltest.yml: You can customise AWS full pipeline tests as required
  • pipeline_todos - TODO string in methods_description_template.yml: #Update the HTML below to your preferred methods description, e.g. add publication citation for this pipeline

:grey_question: Tests ignored:

:white_check_mark: Tests passed:

Run details

  • nf-core/tools version 2.12.1
  • Run at 2024-05-14 01:08:34

github-actions[bot] avatar Mar 08 '24 07:03 github-actions[bot]