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: update docs for v0.9.0 #213

Merged
merged 15 commits into from
Feb 19, 2024
Merged

MRG: update docs for v0.9.0 #213

merged 15 commits into from
Feb 19, 2024

Conversation

ctb
Copy link
Collaborator

@ctb ctb commented Feb 13, 2024

After #197 and #211, we need to switch up our documentation and references for using the branchwater plugin.

This PR also adds documentation for pairwise and suggests .rocksdb as the suffix for index output.

Finally, this PR bumps the version to v0.9.0 in preparation for a release. 🎉

The updated doc/README.md is here.

HackMD version of doc/README.md for nicer viewing/editing: https://hackmd.io/_DqWfa8BS364lfjhnvfnOg?view

@ctb
Copy link
Collaborator Author

ctb commented Feb 15, 2024

@bluegenes I am now using a hackmd to edit doc/README.md! It's directly linked via github in case you want to add or edit, but also happy to take comments and suggestions here on github rather than on hackmd. Whatever works for you.

(I, for one, welcome our new tabulatory overlords!)

If you have time or interest and want to double-check the new table of query/database types, that would be useful - but by no means necessary.

@ctb
Copy link
Collaborator Author

ctb commented Feb 15, 2024

hmm.

  × Preparing editable metadata (pyproject.toml) did not run successfully.
  │ exit code: 1
  ╰─> [15 lines of output]
      error: failed to select a version for `env_logger`.
          ... required by package `sourmash_plugin_branchwater v0.8.7-dev (/home/ctbrown/pyo3_branchwater)`
      versions that meet the requirements `^0.11.1` (locked to 0.11.1) are: 0.11.1
     
      the package `sourmash_plugin_branchwater` depends on `env_logger`, with features: `anstream` but `env_logger` does not have these features.
       It has an optional dependency with that name, but that dependency uses the "dep:" syntax in the features table, so it does not have an implicit feature with that name.
     
     
      failed to select a version for `env_logger` which could resolve this conflict
      � maturin failed
        Caused by: Cargo metadata failed. Does your crate compile with `cargo build`?
        Caused by: `cargo metadata` exited with an error:
      Error running maturin: Command '['maturin', 'pep517', 'write-dist-info', '--metadata-directory', '/scratch/tmp/pip-modern-metadata-bkog6pe2', '--interpreter', '/home/ctbrown/mambaforge/envs/sourmash-dev/bin/python']' returned non-zero exit status 1.
      Checking for Rust toolchain....
      Running `maturin pep517 write-dist-info --metadata-directory /scratch/tmp/pip-modern-metadata-bkog6pe2 --interpreter /home/ctbrown/mambaforge/envs/sourmash-dev/bin/python`
      [end of output]

@ctb
Copy link
Collaborator Author

ctb commented Feb 15, 2024

maybe broken by #209 - will try reverting.

@ctb
Copy link
Collaborator Author

ctb commented Feb 15, 2024

(reversion works)

@ctb
Copy link
Collaborator Author

ctb commented Feb 17, 2024

Ready for review & merge @bluegenes!

@ctb ctb changed the title WIP: update docs for v0.9.0 MRG: update docs for v0.9.0 Feb 17, 2024
Copy link
Contributor

@bluegenes bluegenes left a comment

Choose a reason for hiding this comment

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

made a few suggestions -- otherwise looks good!!

doc/README.md Outdated Show resolved Hide resolved
doc/README.md Show resolved Hide resolved
doc/README.md Outdated Show resolved Hide resolved
src/utils.rs Outdated Show resolved Hide resolved
src/utils.rs Outdated Show resolved Hide resolved
src/utils.rs Outdated Show resolved Hide resolved
@@ -16,7 +16,7 @@ sourmash = { version = "0.12.1", features = ["branchwater"] }
serde_json = "1.0.113"
niffler = "2.4.0"
log = "0.4.14"
env_logger = "0.11.1"
env_logger = "0.10.2"
Copy link
Contributor

Choose a reason for hiding this comment

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

backing up on purpose?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

yes, it causes build problems on linux

@ctb ctb enabled auto-merge (squash) February 19, 2024 16:19
@ctb ctb merged commit 752a5d5 into main Feb 19, 2024
1 check passed
@ctb ctb deleted the update_docs2 branch February 19, 2024 16:33
This was referenced Feb 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants