Skip to content

Add automated docs for nf-core modules lint#1250

Merged
ewels merged 13 commits into
nf-core:devfrom
ErikDanielsson:modules-lint-docs
Mar 16, 2022
Merged

Add automated docs for nf-core modules lint#1250
ewels merged 13 commits into
nf-core:devfrom
ErikDanielsson:modules-lint-docs

Conversation

@ErikDanielsson

Copy link
Copy Markdown
Contributor

Added lint test documentation for nf-core modules lint. The documentation is added in MyST syntax and the PR is thus dependent on the merge of #1245. Should close #1130.

PR checklist

  • This comment contains a description of changes (with reason)
  • CHANGELOG.md is updated
  • If you've fixed a bug or added code that should be tested, add tests!
  • Documentation in docs is updated

@codecov

codecov Bot commented Aug 5, 2021

Copy link
Copy Markdown

Codecov Report

Merging #1250 (0926f03) into dev (3b8d709) will decrease coverage by 0.00%.
The diff coverage is n/a.

❗ Current head 0926f03 differs from pull request most recent head c3224a6. Consider uploading reports for the commit c3224a6 to get more accurate results

@@            Coverage Diff             @@
##              dev    #1250      +/-   ##
==========================================
- Coverage   64.81%   64.80%   -0.01%     
==========================================
  Files          51       51              
  Lines        6002     6001       -1     
==========================================
- Hits         3890     3889       -1     
  Misses       2112     2112              
Impacted Files Coverage Δ
nf_core/lint/modules_json.py 85.00% <ø> (ø)
nf_core/modules/lint/main_nf.py 80.00% <ø> (ø)
nf_core/modules/lint/meta_yml.py 62.16% <ø> (ø)
nf_core/modules/lint/module_changes.py 76.00% <ø> (ø)
nf_core/modules/lint/module_tests.py 70.73% <ø> (-0.70%) ⬇️
nf_core/modules/lint/module_todos.py 100.00% <ø> (ø)
nf_core/modules/lint/module_version.py 84.61% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3b8d709...c3224a6. Read the comment docs.

@ErikDanielsson ErikDanielsson linked an issue Aug 18, 2021 that may be closed by this pull request
@ewels ewels force-pushed the modules-lint-docs branch from a6f8f3a to eadd9e6 Compare March 16, 2022 14:54
@ewels ewels force-pushed the modules-lint-docs branch from eadd9e6 to 0926f03 Compare March 16, 2022 14:57
@ewels ewels merged commit 0a70779 into nf-core:dev Mar 16, 2022
@ErikDanielsson ErikDanielsson deleted the modules-lint-docs branch July 25, 2022 09:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Automated docs generation for nf-core modules lint

2 participants