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

Finish off updating docs and verify infrastructure #64

Merged
merged 8 commits into from
Feb 12, 2025

Conversation

tcharding
Copy link
Member

@tcharding tcharding commented Feb 12, 2025

This is the same as #55 but for the last 3 versions (v26, v27, v28) - once this merges all types version specific module rustdocs correctly document the status of the repository - BOOM!

As with #55 I'm not expecting review, this will be a whole ton of LOC and reviewing it is unrealistic. Its basically just docs and re-exports. Any mistakes should be caught by the verify tool - that is its purpose.

`node` cannot be built without enabling some features.

In preparation for including the `node` crate in the workspace fix the
update lock files script to use `--all-features`.
The comments are stale, fix them to correctly explain how the features
work in this crate.
Add a `TODO` to the integration test crate commenting that we are not
testing the `warnings` field in `CreateWallet`.

Bit sloppy but we have an issue already about test coverage not checking
optional fields.
@tcharding tcharding changed the title 02 13 verify Finish off updating docs and verify infrastructure Feb 12, 2025
Run `just fmt`. No other manual changes.
Update the `types::v26` rustdocs (the SSOT for the status of v26
support). Add `Version::V26` to the `verify` crate.

Verify with `verify v26`.
The `VERSIONS` const is an array that is supposed to include all
supported versions but I forgot to update it as I added support to the
tool for newer versions.

FTR the const is used in the output of `verify v99` (i.e. unsupported
version) and also in `verify all`.
Update the `types::v27` rustdocs (the SSOT for the status of v27
support). Add `Version::V27` to the `verify` crate.

Verify with `verify v27`.
Update the `types::v28` rustdocs (the SSOT for the status of v28
support). Add `Version::V28` to the `verify` crate.

Verify with `verify v28`.
@tcharding tcharding merged commit e13e862 into rust-bitcoin:master Feb 12, 2025
27 checks passed
@tcharding tcharding deleted the 02-13-verify branch February 12, 2025 23:53
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