Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Inconsistencies Between Default Settings in Documentation and Code #148

Closed
spriego opened this issue Mar 20, 2024 · 1 comment
Closed

Inconsistencies Between Default Settings in Documentation and Code #148

spriego opened this issue Mar 20, 2024 · 1 comment

Comments

@spriego
Copy link

spriego commented Mar 20, 2024

Dear Mike,

I've noticed some discrepancies between the default settings outlined in ShortStack's documentation and the actual code:

  1. In the documentation, --mmap is listed as defaulting to f, but in the code (line 535), it's actually set to u.
  2. Regarding --mincov, the documentation indicates a default value of 2, yet in the code (line 601), it's set to 1.
@MikeAxtell
Copy link
Owner

Thanks for pointing these errors out. I've updated the README to correct them.

The --mmap setting of u is the true default, and it is the superior setting according to our previous work https://doi.org/10.1534/g3.116.030452 ... so it was just the README that was wrong, not the software.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants