Misleading TODO item for "contains" entry in test YAML file.

[charles-plessy]

Description of the bug

nf-core modules create-test-yml sometimes inserts the following TODO item:

# TODO nf-core: file md5sum was variable, please replace this text with a string found in the file instead

However, following the instructions results in a borken file, as the contains map need to contain an array.

Expected behaviour

How about either:

• edit the TODO so that it asks the users to ...replace this text with an array of strings found...
• or insert the TODO in an array so that replacing the text results in the correct YAML structure, like:

    files:
      - path: path/to/file
         contains:
           - "# TODO nf-core: file md5sum was variable, please replace..."

[ewels]

Relevant code:

tools/nf_core/modules/test_yml_builder.py

Lines 238 to 244 in d49bf61

	# Compare both test.yml files
	for i in range(len(test_files)):
	if not test_files[i]["md5sum"] == test_files_repeat[i]["md5sum"]:
	test_files[i].pop("md5sum")
	test_files[i][
	"contains"
	] = "# TODO nf-core: file md5sum was variable, please replace this text with a string found in the file instead"

Should be a simple enough change - just wrapping an extra set of [] around the string 👍🏻

Do you fancy putting together a PR @charles-plessy?

[KevinMenden]

closed by #1089