-
Notifications
You must be signed in to change notification settings - Fork 80
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] Add some more doctests for API definition. #436
Conversation
Codecov Report
@@ Coverage Diff @@
## master #436 +/- ##
=========================================
+ Coverage 88.53% 88.64% +0.1%
=========================================
Files 25 25
Lines 3786 3786
Branches 37 37
=========================================
+ Hits 3352 3356 +4
+ Misses 434 430 -4
Continue to review full report at Codecov.
|
I think another pass is needed to adjust the language better in the num vs scaled section, but otherwise I like. @luizirber any thoughts? |
I've decided I like it. @luizirber ready for review and merge? :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it does a good job at covering what we have nowadays.
What bothers me is that we still conflate sigs and minhashes sometimes (especially the load_one_signature
function), but that will only be fixable in sourmash 3.0...
Co-Authored-By: ctb <[email protected]>
Fixes #329 #147 by adding lots of API documentation.
See expanded docs here.
Also fixes #580 (database scaled values) 'cause why not.
make test
Did it pass the tests?make coverage
Is the new code covered?without a major version increment. Changing file formats also requires a
major version number increment.
changes were made?