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

Removing text from doc/command-line.md to fix the sourmash signature split docs #1431

Conversation

keyabarve
Copy link
Contributor

@keyabarve keyabarve commented Apr 1, 2021

  • The sourmash signature split docs incorrectly state that it is the only command that supports loading signatures from LCA and SBTs.
    The following text has been removed from doc/command-line.md in the sourmash repo:

Note: unlike the rest of the sourmash sig commands, split can load signatures from LCA and SBT databases as well.

Please also be sure to note here if file formats, command-line
interface, and/or the top-level sourmash API will change because of
this PR.

@keyabarve keyabarve changed the title Removing text from doc/command line.md to fix the sourmash signature split docs Removing text from doc/command line.md to fix the sourmash signature split docs Apr 1, 2021
@codecov
Copy link

codecov bot commented Apr 1, 2021

Codecov Report

Merging #1431 (b472cca) into latest (3c29b1b) will increase coverage by 5.21%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           latest    #1431      +/-   ##
==========================================
+ Coverage   89.27%   94.49%   +5.21%     
==========================================
  Files         123       96      -27     
  Lines       18790    15176    -3614     
  Branches     1447     1447              
==========================================
- Hits        16775    14340    -2435     
+ Misses       1782      603    -1179     
  Partials      233      233              
Flag Coverage Δ
python 94.49% <ø> (ø)
rust ?

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

Impacted Files Coverage Δ
src/core/src/ffi/mod.rs
src/core/src/signature.rs
src/core/src/index/mod.rs
src/core/src/index/search.rs
src/core/src/sketch/hyperloglog/estimators.rs
src/core/src/wasm.rs
src/core/src/sketch/nodegraph.rs
src/core/src/ffi/signature.rs
src/core/src/ffi/nodegraph.rs
src/core/src/cmd.rs
... and 17 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 3c29b1b...b472cca. Read the comment docs.

@keyabarve keyabarve changed the title Removing text from doc/command line.md to fix the sourmash signature split docs Removing text from doc/command-line.md to fix the sourmash signature split docs Apr 1, 2021
@keyabarve
Copy link
Contributor Author

Please review. @ctb @luizirber

@ctb
Copy link
Contributor

ctb commented Apr 2, 2021

hi @keyabarve it looks like you started from the branch you used here - #1423. If you look at the diff, you'll see all of those changes are part of this PR, too, and were even before I merged them into latest.

To avoid this, when you make a new branch make sure to do the following:

git checkout latest
git pull origin latest
git checkout -b <new branch>

thanks!

@keyabarve
Copy link
Contributor Author

@ctb I realized my mistake. I will keep that in mind from next time.

@ctb ctb changed the title Removing text from doc/command-line.md to fix the sourmash signature split docs Removing text from doc/command-line.md to fix the sourmash signature split docs Apr 2, 2021
@ctb ctb merged commit ed3c809 into latest Apr 2, 2021
@ctb ctb deleted the Removing-text-from-doc/command-line.md-to-fix-the-sourmash-signature-split-docs branch April 2, 2021 13:13
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.

fix sourmash split docs
2 participants