-
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] update the sourmash __init__.py docstring #1364
Conversation
Codecov Report
@@ Coverage Diff @@
## latest #1364 +/- ##
==========================================
+ Coverage 88.84% 94.13% +5.29%
==========================================
Files 123 96 -27
Lines 18273 14656 -3617
Branches 1409 1409
==========================================
- Hits 16235 13797 -2438
+ Misses 1800 621 -1179
Partials 238 238
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report at Codecov.
|
Ready for review @luizirber @bluegenes |
from deprecation import deprecated | ||
|
||
__all__ = ['MinHash', 'SourmashSignature', | ||
'load_one_signature', |
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.
is load_one_signature
also deprecated / to be removed in 5.0?
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.
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 don't think I can properly evaluate additional things that might be useful here .. but this seems more informative/useful than before, makes sense, looks good
thanks @bluegenes! @luizirber lmk if you have additional thoughts, no particular hurry on merging this. |
Adds a better docstring and
__all__
tosrc/sourmash/__init__.py
.Fixes #1233.
Checklist
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?