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

[MRG] fix doc titles in command-line.md and update description a bit #1874

Merged
merged 3 commits into from
Mar 10, 2022

Conversation

ctb
Copy link
Contributor

@ctb ctb commented Mar 8, 2022

Minor updates to command-line docs, initiated because I noticed that the prefetch section headers were at the wrong level.

This PR affects only command-line.md, and:

  • adjusts prefetch section headers
  • adds containment to the comment about similarity
  • removes an outdated warning
  • adds a reference to the gather preprint

Addresses #1789 but doesn't fix it.

@codecov
Copy link

codecov bot commented Mar 8, 2022

Codecov Report

Merging #1874 (4a106df) into latest (ba38d14) will increase coverage by 7.93%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           latest    #1874      +/-   ##
==========================================
+ Coverage   82.52%   90.46%   +7.93%     
==========================================
  Files         121       91      -30     
  Lines       13061     8859    -4202     
  Branches     1751     1751              
==========================================
- Hits        10779     8014    -2765     
+ Misses       2016      579    -1437     
  Partials      266      266              
Flag Coverage Δ
python 90.46% <ø> (ø)
rust ?

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

Impacted Files Coverage Δ
src/core/src/sketch/hyperloglog/mod.rs
src/core/src/index/sbt/mod.rs
src/core/src/storage.rs
src/core/src/index/linear.rs
src/core/src/signature.rs
src/core/src/index/sbt/mhbt.rs
src/core/src/ffi/hyperloglog.rs
src/core/src/index/bigsi.rs
src/core/tests/minhash.rs
src/core/src/index/mod.rs
... and 20 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ba38d14...4a106df. Read the comment docs.

@ctb
Copy link
Contributor Author

ctb commented Mar 8, 2022

Ready for review & merge @sourmash-bio/devs

(I'm aware we need lots of doc updates around FracMinHash. Please don't ask me to do more in this PR :)

Copy link
Contributor

@bluegenes bluegenes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor suggestion, otherwise lgtm :)

doc/command-line.md Outdated Show resolved Hide resolved
Co-authored-by: Tessa Pierce Ward <[email protected]>
@ctb ctb merged commit dff5309 into latest Mar 10, 2022
@ctb ctb deleted the fix/doc_titles branch March 10, 2022 20:18
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.

2 participants