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] add information about versioning, migrations, etc to the docs #1153

Merged
merged 5 commits into from
Aug 7, 2020

Conversation

ctb
Copy link
Contributor

@ctb ctb commented Aug 7, 2020

Upgrade documentation in preparation for v4.

ref #1033, #655, #1069, #1145, #1128

  • 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
Copy link
Contributor Author

ctb commented Aug 7, 2020

@luizirber the overall shape of the text is at a resting place, and I welcome your thoughts on what topics I'm missing! (I've yet to review the actual formatting.)

@codecov
Copy link

codecov bot commented Aug 7, 2020

Codecov Report

Merging #1153 into latest will increase coverage by 9.14%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           latest    #1153      +/-   ##
==========================================
+ Coverage   83.72%   92.86%   +9.14%     
==========================================
  Files          95       71      -24     
  Lines        9012     5636    -3376     
==========================================
- Hits         7545     5234    -2311     
+ Misses       1467      402    -1065     
Flag Coverage Δ
#rusttests ?

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

Impacted Files Coverage Δ
sourmash/signature.py 92.53% <0.00%> (-0.29%) ⬇️
sourmash/sbtmh.py 89.52% <0.00%> (-0.20%) ⬇️
sourmash/command_compute.py 97.43% <0.00%> (-0.20%) ⬇️
sourmash/nodegraph.py 93.45% <0.00%> (-0.18%) ⬇️
sourmash/minhash.py 97.10% <0.00%> (-0.16%) ⬇️
sourmash/sbt_storage.py 92.42% <0.00%> (-0.12%) ⬇️
sourmash/index.py 97.56% <0.00%> (-0.09%) ⬇️
sourmash/sbt.py 88.49% <0.00%> (-0.07%) ⬇️
sourmash/lca/lca_db.py 97.16% <0.00%> (-0.05%) ⬇️
sourmash/cli/__init__.py 98.90% <0.00%> (-0.02%) ⬇️
... and 24 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 80d846e...939c2f1. Read the comment docs.

doc/index.md Outdated Show resolved Hide resolved
doc/index.md Show resolved Hide resolved
@luizirber
Copy link
Member

@luizirber the overall shape of the text is at a resting place, and I welcome your thoughts on what topics I'm missing! (I've yet to review the actual formatting.)

I'm pretty happy with it as-is, I think it touches all the important points!

@ctb ctb changed the title [WIP] add information about versioning, migrations, etc to the docs [MRG] add information about versioning, migrations, etc to the docs Aug 7, 2020
@ctb
Copy link
Contributor Author

ctb commented Aug 7, 2020

Ready for review!

@luizirber luizirber merged commit dff1219 into latest Aug 7, 2020
@luizirber luizirber deleted the add_migration_info branch August 7, 2020 17:50
@ctb ctb mentioned this pull request Feb 7, 2021
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.

2 participants