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

[WIP] Adding some docstrings #1583

Open
wants to merge 1 commit into
base: latest
Choose a base branch
from
Open

[WIP] Adding some docstrings #1583

wants to merge 1 commit into from

Conversation

hehouts
Copy link
Contributor

@hehouts hehouts commented Jun 11, 2021

adding docs strings to cli/, minhash.py and sig.py
Chips away at #1563

@codecov
Copy link

codecov bot commented Jun 11, 2021

Codecov Report

Merging #1583 (718aa04) into latest (a782b1d) will decrease coverage by 0.92%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           latest    #1583      +/-   ##
==========================================
- Coverage   90.20%   89.28%   -0.93%     
==========================================
  Files         126       75      -51     
  Lines       21194     6626   -14568     
  Branches     1595     1171     -424     
==========================================
- Hits        19118     5916   -13202     
+ Misses       1844      505    -1339     
+ Partials      232      205      -27     
Flag Coverage Δ
python 89.28% <100.00%> (-5.92%) ⬇️
rust ?

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

Impacted Files Coverage Δ
src/sourmash/cli/sig/split.py 100.00% <ø> (ø)
src/sourmash/cli/sig/subtract.py 100.00% <ø> (ø)
src/sourmash/cli/sketch/__init__.py 100.00% <ø> (ø)
src/sourmash/cli/sketch/dna.py 100.00% <ø> (ø)
src/sourmash/cli/sketch/protein.py 100.00% <ø> (ø)
src/sourmash/cli/sketch/translate.py 100.00% <ø> (ø)
src/sourmash/cli/storage/__init__.py 100.00% <ø> (ø)
src/sourmash/cli/storage/convert.py 100.00% <ø> (ø)
src/sourmash/minhash.py 90.62% <100.00%> (+0.70%) ⬆️
src/sourmash/sourmash_args.py 94.24% <0.00%> (-0.18%) ⬇️
... and 68 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 a782b1d...718aa04. Read the comment docs.

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.

1 participant