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.

Sign up for GitHub

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

Jump to bottom

Preparing for release #8

Merged

mattxwang merged 2 commits into main from release-prep

Jul 17, 2023

Member

mattxwang commented Jul 17, 2023 •

edited

Loading

This PR bundles together various improvements for an alpha release.

adds doctests for all public functions, and an e2e test for the entire public API
changes all &String parameters to &str
fixes naming conventions to abide by Rust's API guidelines, primarily removing get from our getters
fleshes out README
adds relevant Cargo.toml metadata to publish crate


          Add doctests for all public functions, fix naming

e8418d5

For naming conventions, see: https://rust-lang.github.io/api-guidelines/naming.html

mattxwang force-pushed the release-prep branch from bc4ba85 to e8418d5 Compare

July 17, 2023 18:56


          Updates Cargo.toml and README

ee54026

mattxwang merged commit 221f213 into main

mattxwang deleted the release-prep branch

July 17, 2023 19:12

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet