Improve documentation writing

nf-core / tools

Python package with helper tools for the nf-core community.

https://nf-co.re

MIT License

242 stars 191 forks source link

Improve documentation writing #3302

Open LouisLeNezet opened 2 days ago

LouisLeNezet commented 2 days ago

During the review of the phaseimpute pipeline a few comments was done on portions of the documentation originating from the template. Here is the improved documentation.

PR checklist

[x] This comment contains a description of changes (with reason)
[x] 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[bot] commented 2 days ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 75.72%. Comparing base (1dd8ea0) to head (82d6797).

Additional details and impacted files

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.