Do a bunch of cleanups #154
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Merged
We have one single rustdoc line that does not use a fixed column width as the rest do, this is likely an oversight - fix it.
In the `SegwitHrpstringError` we return the `MissingWitnessVersion` variant when the encoded data is empty. While true, the witness version is missing this error is not totally descriptive because the error case is more specific than that. Rename `SegwitHrpstringError::MissingWitnessVersion` to `SegwitHrpstringError::NoData`.
The `crate::{encode, decode}` API is for encoding/decoding bech32
strings not specifically addresses (for example miniscript descriptors
are bech32 strings but not addresses).
Use the words "bech32 string" instead of "address" in `lib.rs`.
tcharding
force-pushed
the
10-25-clean-up
branch
from
3771167 to
79f0bb0
Compare
|
Can you find a citation for the |
|
Oh its definitely a convention, its one of the first ones I remember learning that I disagreed with when I first started Rusting. I patched an open source library with it too (yep I was that guy). I'll go digging for you ... hold the phone, the docs for |
tcharding
force-pushed
the
10-25-clean-up
branch
from
79f0bb0 to
8426386
Compare
|
Dropped the last patch (the |
apoelstra
approved these changes
Oct 25, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is the first 4 patches from #142, pushing up separately because that PR is quite complicated to review well and these cleanups are unrelated.