BioJulia / FASTX.jl

Parse and process FASTA and FASTQ formatted files of biological sequences.
https://biojulia.dev
MIT License
61 stars 20 forks source link

Make documentation more approachable #113

Closed jakobnissen closed 1 year ago

jakobnissen commented 1 year ago

Mention the most important things first in the documentation: How to read and write files.

codecov[bot] commented 1 year ago

Codecov Report

Patch and project coverage have no change.

Comparison is base (d0eb7ea) 89.78% compared to head (572e8c4) 89.78%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #113 +/- ## ======================================= Coverage 89.78% 89.78% ======================================= Files 15 15 Lines 695 695 ======================================= Hits 624 624 Misses 71 71 ``` | [Flag](https://app.codecov.io/gh/BioJulia/FASTX.jl/pull/113/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BioJulia) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/BioJulia/FASTX.jl/pull/113/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BioJulia) | `89.78% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BioJulia#carryforward-flags-in-the-pull-request-comment) to find out more.

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