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

Expand descriptions of LSH-relevant arguments in README and help messages #57

Merged
merged 4 commits into from
Jan 25, 2024

Conversation

haydenm
Copy link
Collaborator

@haydenm haydenm commented Jan 15, 2024

This PR expands descriptions of arguments that use locality-sensitive hashing—to lower runtime and memory usage on especially large inputs—in the README and help messages. Namely, the PR:

  • Adds technical detail to the arguments in the README, borrowing from the help messages
  • Adds detail on why certain values for these arguments are recommended and reasonable in practice
  • Makes minor changes to the help messages

Copy link

codecov bot commented Jan 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (895a7e3) 93.73% compared to head (d178bd4) 93.73%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master      #57   +/-   ##
=======================================
  Coverage   93.73%   93.73%           
=======================================
  Files          63       63           
  Lines        6115     6115           
=======================================
  Hits         5732     5732           
  Misses        383      383           
Flag Coverage Δ
unittests 93.73% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@haydenm haydenm merged commit 29f3386 into master Jan 25, 2024
14 checks passed
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.

1 participant