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

document and test skipmer moltypes #3449

Open
bluegenes opened this issue Dec 20, 2024 · 0 comments
Open

document and test skipmer moltypes #3449

bluegenes opened this issue Dec 20, 2024 · 0 comments

Comments

@bluegenes
Copy link
Contributor

bluegenes commented Dec 20, 2024

Skipmers are being added to both the rust layer (#3395) and python layer (#3446). These will remain undocumented for now as they are for testing + experimentation.

Add documentation + skipmer tests prior to release.

@bluegenes bluegenes changed the title document skipmer moltypes document and test skipmer moltypes Dec 20, 2024
bluegenes added a commit that referenced this issue Dec 20, 2024
This PR updates the FFI and python layer to allow the skipmer moltypes
(`skipm1n3`, `skipm2n3`). We will keep this as an undocumented
experimental feature for now. There are no guarantees at the moment that
skipmers will work with all sourmash commands, as there are no explicit
tests in place. There *are* tests for using skipmers with branchwater,
so all skipmer searching is best done in the plugin for now. This PR
enables critical handy utilities, though: `sig cat`, `sig summarize`,
`sig describe`, etc.

Documentation and additional tests should be added prior to
release(#3449).

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: C. Titus Brown <[email protected]>
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

No branches or pull requests

1 participant