[go: nahoru, domu]

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] Improve signature save docstring; switch docstrings over to markdown #921

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

ctb
Copy link
Contributor
@ctb ctb commented Mar 28, 2020

This addresses part of #919.

I decided to try out this idea and switch docstrings over to markdown from reStructuredText. I think this makes things friendlier to people used to markdown (which is used much more widely than ReST but we would need to redo the SBT docstrings. @luizirber any thoughts?

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

@sonarcloud
Copy link
sonarcloud bot commented Mar 28, 2020

Kudos, SonarCloud Quality Gate passed!

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities (and Security Hotspot 0 Security Hotspots to review)
Code Smell A 1 Code Smell

No Coverage information No Coverage information
0.0% 0.0% Duplication

@codecov
Copy link
codecov bot commented Mar 28, 2020

Codecov Report

Merging #921 into master will not change coverage by %.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #921   +/-   ##
=======================================
  Coverage   91.77%   91.77%           
=======================================
  Files          70       70           
  Lines        4947     4947           
=======================================
  Hits         4540     4540           
  Misses        407      407           
Impacted Files Coverage Δ
sourmash/_minhash.py 95.02% <ø> (ø)
sourmash/sbt.py 86.79% <ø> (ø)
sourmash/signature.py 86.77% <ø> (ø)

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 0362ac3...1d32163. 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.

None yet

1 participant