Fix "Quick Start" parameters - Githubissues

maize-genetics / phg_v2

Practical Haplotype Graph (PHG) version 2

https://phg.maizegenetics.net/

Apache License 2.0

21 stars 2 forks source link

Fix "Quick Start" parameters #213

Closed btmonier closed 2 months ago

btmonier commented 2 months ago

Description

This PR:

Fixes a parameter typo found in the align-assemblies command in the "Quick Start" section
Adds another warning found in one of the call-outs in the "Create Ranges" section (didn't forget about this, @zrm22)

Type of change

What type of changes does your code introduce? Put an x in boxes that apply.

[ ] CHANGE (fix or feature that would cause existing functionality to not work as expected)
[ ] FEATURE (non-breaking change which adds functionality)
[ ] BUGFIX (non-breaking change which fixes an issue)
[ ] ENHANCEMENT (non-breaking change which improves existing functionality)
[x] NONE (if none of the other choices apply. Example, tooling, build system, CI, docs, etc.)

Checklist:

[ ] I have performed a self-review of my code
[ ] I have commented my code, particularly in hard-to-understand areas
[x] I have updated relevant documentation

Changelog entry

Please add a one-line changelog entry below. This will be copied to the changelog file during the release process.