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] update the sourmash __init__.py docstring #1364

Merged
merged 4 commits into from
Mar 9, 2021
Merged

Conversation

ctb
Copy link
Contributor

@ctb ctb commented Mar 4, 2021

Adds a better docstring and __all__ to src/sourmash/__init__.py.

Fixes #1233.

Checklist

  • Is it mergeable?
  • make test Did it pass the tests?
  • make coverage Is the new code covered?
  • Did it change the command-line interface? Only additions are allowed
    without a major version increment. Changing file formats also requires a
    major version number increment.
  • Was a spellchecker run on the source code and documentation after
    changes were made?

@codecov
Copy link

codecov bot commented Mar 4, 2021

Codecov Report

Merging #1364 (91765d9) into latest (1e96920) will increase coverage by 5.29%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            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              
Flag Coverage Δ
python 94.13% <100.00%> (-0.01%) ⬇️
rust ?

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

Impacted Files Coverage Δ
src/sourmash/__init__.py 90.90% <100.00%> (-0.76%) ⬇️
src/core/src/sketch/minhash.rs
src/core/src/from.rs
src/core/src/lib.rs
src/core/src/index/search.rs
src/core/tests/minhash.rs
src/core/src/ffi/cmd/compute.rs
src/core/src/errors.rs
src/core/src/ffi/hyperloglog.rs
src/core/src/ffi/mod.rs
... and 18 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 1e96920...91765d9. Read the comment docs.

@ctb
Copy link
Contributor Author

ctb commented Mar 5, 2021

Ready for review @luizirber @bluegenes

from deprecation import deprecated

__all__ = ['MinHash', 'SourmashSignature',
'load_one_signature',
Copy link
Contributor

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?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

no - it's used too widely/is too useful - see #1062 for discussion.

I know it's a little inconsistent but I went for practicality here ;).

ref #1279

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.

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

@ctb
Copy link
Contributor Author

ctb commented Mar 5, 2021

thanks @bluegenes! @luizirber lmk if you have additional thoughts, no particular hurry on merging this.

@ctb ctb merged commit 001cd35 into latest Mar 9, 2021
@ctb ctb deleted the update/sourmash__doc__ branch March 9, 2021 14:42
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.

improve sourmash top-level docstring
2 participants