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] Documentation updates for 4.0 release #1283

Merged
merged 28 commits into from
Feb 17, 2021
Merged

[MRG] Documentation updates for 4.0 release #1283

merged 28 commits into from
Feb 17, 2021

Conversation

ctb
Copy link
Contributor

@ctb ctb commented Jan 18, 2021

URL for build: https://sourmash.readthedocs.io/en/docs_4.0/

Fixes #1168, sourmash sketch docs
Fixes #1142, docs for new top-level signature loading API
Fixes #919 - better docs for save/load signatures
Fixes #973 - better indexed database docs
Willfix #1069 once #1316 is merged into this PR.

TODO:

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 Jan 18, 2021

Codecov Report

Merging #1283 (71ef18d) into latest (6f2664e) will increase coverage by 5.32%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           latest    #1283      +/-   ##
==========================================
+ Coverage   88.74%   94.06%   +5.32%     
==========================================
  Files         123       96      -27     
  Lines       18124    14510    -3614     
  Branches     1399     1399              
==========================================
- Hits        16084    13649    -2435     
+ Misses       1801      622    -1179     
  Partials      239      239              
Flag Coverage Δ
python 94.06% <ø> (ø)
rust ?

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

Impacted Files Coverage Δ
src/core/src/sketch/minhash.rs
src/core/src/wasm.rs
src/core/src/sketch/nodegraph.rs
src/core/src/index/sbt/mod.rs
src/core/src/index/storage.rs
src/core/src/ffi/cmd/compute.rs
src/core/src/ffi/hyperloglog.rs
src/core/src/index/sbt/mhbt.rs
src/core/src/ffi/utils.rs
src/core/src/signature.rs
... and 17 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 6f2664e...71ef18d. Read the comment docs.

@ctb ctb changed the title Documentation updates for 4.0 release [WIP] Documentation updates for 4.0 release Feb 7, 2021
@ctb ctb mentioned this pull request Feb 7, 2021
@ctb
Copy link
Contributor Author

ctb commented Feb 8, 2021

I think this is ready for review; the only remaining issues have to deal with tutorials, notebooks, and migration docs, and are pretty isolated (and can be reviewed piecemeal as PRs into this one).

@taylorreiter go for it!

Copy link
Contributor

@taylorreiter taylorreiter left a comment

Choose a reason for hiding this comment

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

this is a wonderful docs update! some suggestions included.

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
doc/api-example.md Outdated Show resolved Hide resolved
doc/classifying-signatures.md Outdated Show resolved Hide resolved
doc/command-line.md Show resolved Hide resolved
doc/sourmash-sketch.md Outdated Show resolved Hide resolved
doc/sourmash-sketch.md Outdated Show resolved Hide resolved
doc/sourmash-sketch.md Outdated Show resolved Hide resolved
doc/sourmash-sketch.md Outdated Show resolved Hide resolved
doc/tutorial-basic.md Outdated Show resolved Hide resolved
ctb and others added 2 commits February 9, 2021 10:15
* add migration docs and release notes

* Update doc/support.md

Co-authored-by: Taylor Reiter <taylorreiter@gmail.com>

* Update doc/support.md

Co-authored-by: Taylor Reiter <taylorreiter@gmail.com>

* Update doc/release-notes/sourmash-4.0.md

Co-authored-by: Taylor Reiter <taylorreiter@gmail.com>

* Update doc/release-notes/sourmash-4.0.md

Co-authored-by: Taylor Reiter <taylorreiter@gmail.com>

* Update doc/release-notes/sourmash-4.0.md

Co-authored-by: Taylor Reiter <taylorreiter@gmail.com>

* update with last set of changes

* add missing line break

Co-authored-by: Taylor Reiter <taylorreiter@gmail.com>
@ctb ctb mentioned this pull request Feb 9, 2021
@ctb
Copy link
Contributor Author

ctb commented Feb 9, 2021

OK, @luizirber, I think this is fully baked! ready for your review.

@ctb ctb changed the title [WIP] Documentation updates for 4.0 release [MRG] Documentation updates for 4.0 release Feb 13, 2021
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: Luiz Irber <luizirber@users.noreply.github.com>
Copy link
Member

@luizirber luizirber left a comment

Choose a reason for hiding this comment

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

Just a couple of comments, but LGTM!

doc/release-notes/sourmash-4.0.md Show resolved Hide resolved
doc/support.md Outdated Show resolved Hide resolved
doc/tutorial-basic.md Show resolved Hide resolved
Co-authored-by: Luiz Irber <luizirber@users.noreply.github.com>
@ctb ctb merged commit 74a7f25 into latest Feb 17, 2021
@ctb ctb deleted the docs_4.0 branch February 17, 2021 23:09
@ctb
Copy link
Contributor Author

ctb commented Feb 17, 2021

🎉

@ctb ctb mentioned this pull request Feb 18, 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
4 participants