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

Do various improvements #23

Merged
merged 9 commits into from
Dec 29, 2024
Merged

Conversation

tcharding
Copy link
Member

@tcharding tcharding commented Dec 29, 2024

Done while going over the Rust API checklist in #16. Nothing too crazy here.

When building a package to release on `crates.io` we don't need to
include the `tests` directory or the `contrib` directory. However other
config files are fine to include (they are small).
Pedantic I know. Put the `dependencies` section after then `features` in
the manifest.
Add the two other coding conventions from `rust-bitcoin`.
Flesh out the rustdocs for the crate and the `Ordered` type.
This is strictly not needed because we don't have any features. But it
doesn't hurt and it protects us later if we add any.
Enable the exhaustive list of the pedantic clippy lints.

Allow `ptr_as_ptr` because the warning looks harmless.
Copy the current `rusntfmt` config file from `rust-bitcoin` and run the
formatter.
Copy test from Rust API guidlines document to verify `Send` and `Sync`
are correct.
Put the constructor method above the getters.

Code move only.
@tcharding tcharding merged commit 5c6ec75 into rust-bitcoin:master Dec 29, 2024
11 checks passed
@tcharding tcharding deleted the 12-29-improve branch December 29, 2024 20:40
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

Successfully merging this pull request may close these issues.

1 participant