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 API docs #596

Merged
merged 6 commits into from Jan 3, 2019

Conversation

Projects
None yet
2 participants
@ctb
Copy link
Member

ctb commented Jan 2, 2019

Puts 'API' in the title, includes a cute tidbit about scaled=1.

  • 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?
@ctb

This comment has been minimized.

Copy link
Member

ctb commented Jan 2, 2019

This should be ready for review and merge @luizirber! After merge we should check to make sure that https://sourmash.readthedocs.io/en/latest/api-example.html is automatically updated :)

@codecov

This comment has been minimized.

Copy link

codecov bot commented Jan 2, 2019

Codecov Report

Merging #596 into master will increase coverage by 0.39%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #596      +/-   ##
==========================================
+ Coverage   88.24%   88.64%   +0.39%     
==========================================
  Files          25       25              
  Lines        3785     3786       +1     
  Branches       37       37              
==========================================
+ Hits         3340     3356      +16     
+ Misses        445      430      -15
Impacted Files Coverage Δ
sourmash/sbt.py 85.71% <0%> (+0.39%) ⬆️
sourmash/lca/command_index.py 90.26% <0%> (+0.44%) ⬆️
sourmash/lca/lca_utils.py 95.23% <0%> (+0.79%) ⬆️
sourmash/signature_json.py 96.25% <0%> (+1.25%) ⬆️
sourmash/sbt_storage.py 95.5% <0%> (+9.14%) ⬆️

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 99e5c46...d383b12. Read the comment docs.

Show resolved Hide resolved doc/api-example.md Outdated

luizirber and others added some commits Jan 3, 2019

Update doc/api-example.md
Co-Authored-By: ctb <titus@idyll.org>
@luizirber
Copy link
Member

luizirber left a comment

I pushed a change to fix the link in a rst file (link was formatted as markdown).

@luizirber luizirber merged commit 82fb36e into master Jan 3, 2019

@luizirber luizirber deleted the update/api-docs-more branch Jan 3, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment