nf-core / nf-core/tools

stub `.gz` linting is too restrictive

Open Beginner friendly
#4,231 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug good-first-issue
Dominant language
Python
Stars
322
Forks
255
Avg merge
2d 3h
Merged PRs (30d)
5

Description

Description of the bug
Image

This is the linting error that we get here https://github.com/nf-core/modules/pull/11312. It says that the stub syntax should be echo "" | gzip > but echo | gzip > is equally valid. Please reflect that in the linting.

Also related to #4205

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the linting error shown in nf-core/modules pull request #11312 and read the related discussion in issue #4205. Locate the linting rule that rejects echo | gzip > and compare it with the accepted echo "" | gzip > form. Done means both valid stub forms pass linting without weakening other .gz checks.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.