-
Notifications
You must be signed in to change notification settings - Fork 80
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
Conversation
Codecov Report
@@ 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
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report at Codecov.
|
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! |
There was a problem hiding this 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.
Co-authored-by: Taylor Reiter <taylorreiter@gmail.com>
Co-authored-by: Taylor Reiter <taylorreiter@gmail.com>
* 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>
OK, @luizirber, I think this is fully baked! ready for your review. |
…tions (#1330) * update 4.0 migration docs with version pinning instructions * update migration docs
Co-authored-by: Luiz Irber <luizirber@users.noreply.github.com>
There was a problem hiding this 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!
Co-authored-by: Luiz Irber <luizirber@users.noreply.github.com>
🎉 |
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:
sourmash sketch
docssourmash compute
tosourmash sketch
in the markdown docs-p
format in the markdown docssourmash compute
tosourmash sketch
in tutorials and notebooks-p
format in tutorials and notebookssinglehtml
orlatexpdf
load_file_as_signatures
andload_databases
per makeload_database
andload_file_as_signatures
the new top-level/public API for loading signatures. #1142Checklist
make test
Did it pass the tests?make coverage
Is the new code covered?without a major version increment. Changing file formats also requires a
major version number increment.
changes were made?