Fix typos highlighted in closed LLM PRs
What changed, and why it matters
This commit fixes only spelling mistakes in documentation and a test comment. There are no code behavior changes, no security fixes, and no functional changes to the library.
No action needed; this is a documentation-only cleanup commit with no security relevance.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff corrects typos in CONTRIBUTING.md, bitcoin/CHANGELOG.md, and a comment in consensus_encoding/tests/decode.rs. Examples include ‘functional’ → ‘functionality’, ‘bench mark’ → ‘benchmark’, ‘KnowHrp``’ → ‘KnownHrp’, and ‘boundry’ → ‘boundary’. No executable code was modified.
Changed components
CONTRIBUTING.mdbitcoin/CHANGELOG.mdconsensus_encoding/tests/decode.rs (comment only)Inspect captured patch +9 / −9
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index c71b4509..c4d0a7f8 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -171,7 +171,7 @@ Prerequisites that a PR must satisfy for merging into the `master` branch:
* the tip of any PR branch must also compile and pass tests with no errors on
MSRV (check [README.md] on current MSRV requirements) and pass fuzz tests on
nightly rust;
-* contain all necessary tests for the introduced functional (either as a part of
+* contain all necessary tests for the introduced functionality (either as a part of
commits, or, more preferably, as separate commits, so that it's easy to
reorder them during review and check that the new tests fail without the new
code);
@@ -328,8 +328,8 @@ Run as for any other Rust project `cargo test --all-features`.
### Benchmarks
-We use a custom Rust compiler configuration conditional to guard the bench mark code. To run the
-bench marks use: `RUSTFLAGS='--cfg=bench' cargo +nightly bench`.
+We use a custom Rust compiler configuration conditional to guard the benchmark code. To run the
+benchmarks use: `RUSTFLAGS='--cfg=bench' cargo +nightly bench`.
### Mutation tests
diff --git a/bitcoin/CHANGELOG.md b/bitcoin/CHANGELOG.md
index 50cd9af3..2d73fe6a 100644
--- a/bitcoin/CHANGELOG.md
+++ b/bitcoin/CHANGELOG.md
@@ -2,7 +2,7 @@
This series of beta releases is meant for two things:
-1. To allow testing of the upcoming `bitcoin v0.33.0`. Its been a long
+1. To allow testing of the upcoming `bitcoin v0.33.0`. It's been a long
time since we released and there is a lot in this.
2. To allow testing of the `1.0.0` RC releases of:
@@ -27,7 +27,7 @@ For changes to our dependencies included in this release see:
- `hex-conservative 1.0.0`: [changelog](https://github.com/rust-bitcoin/hex-conservative/blob/1.x/CHANGELOG.md)
- `hex-conservative 0.3`: [changelog](https://github.com/rust-bitcoin/hex-conservative/blob/master/CHANGELOG.md)
-## Worthy on note
+## Worthy of note
This release introduces an upper limit on the `Amount` type.
@@ -134,7 +134,7 @@ The `serde` serialization for `Psbt` has changed.
you may want to use `MAX_REDEEM_SCRIPT_SIZE` or perhaps `MAX_STACK_ELEMENT_SIZE` (see `bitcoin/src/blockdata/constants`).
- `ecdsa::Error` was replaced by `ecdsa::DecodeError` and `ecdsa::ParseSignatureError`
(returned by `ecdsa::Signature::from_slice` and `from_str` respectively).
-- `script::read_scriptint` was move to be a method on `PushBytes`.
+- `script::read_scriptint` was moved to be a method on `PushBytes`.
- You can likely just remove the `hashes::Hash` trait import.
- Change `OutPoint::default()` to `OutPoint::COINBASE_PREVOUT` if appropriate.
- Change `TxIn::default()` to `TxIn::EMPTY_COINBASE` if appropriate.
@@ -236,7 +236,7 @@ In particular consider having some type that implements `AsRef<Params>`, we have
- Remove `Network` from `AddressInner` [#1832](https://github.com/rust-bitcoin/rust-bitcoin/pull/1832)
- Add consts to `Params` for individual networks [#2396](https://github.com/rust-bitcoin/rust-bitcoin/pull/2396)
- Add `params()` method to `Network` [#2172](https://github.com/rust-bitcoin/rust-bitcoin/pull/2172)
-- Use `KnowHrp`` instead of `Network` [#2387](https://github.com/rust-bitcoin/rust-bitcoin/pull/2387)
+- Use `KnownHrp` instead of `Network` [#2387](https://github.com/rust-bitcoin/rust-bitcoin/pull/2387)
- Add check to max difficulty transition threshold [#2337](https://github.com/rust-bitcoin/rust-bitcoin/pull/2337)
## Other API additions
@@ -341,7 +341,7 @@ In particular consider having some type that implements `AsRef<Params>`, we have
- Rename `TaprootSpendInfo::as_script_map` to `script_map` [#1897](https://github.com/rust-bitcoin/rust-bitcoin/pull/1897)
- Rename `Script::empty` to `Script::new` [#1925](https://github.com/rust-bitcoin/rust-bitcoin/pull/1925)
- Rename `PartiallySignedTransaction` to `Psbt` [#1938](https://github.com/rust-bitcoin/rust-bitcoin/pull/1938)
- - Rename `XpubIdenifier` to `XKeyIdentifier` [#2021](https://github.com/rust-bitcoin/rust-bitcoin/pull/2021)
+ - Rename `XpubIdentifier` to `XKeyIdentifier` [#2021](https://github.com/rust-bitcoin/rust-bitcoin/pull/2021)
- Rename `ExtendedPubKey` to `Xpub` [#2019](https://github.com/rust-bitcoin/rust-bitcoin/pull/2019)
- Rename `ExtendedPrivKey` to `Xpriv` [#2019](https://github.com/rust-bitcoin/rust-bitcoin/pull/2019)
- Remove `_v0` from various function names (eg, `new_v0_p2wpkh`) [#1994](https://github.com/rust-bitcoin/rust-bitcoin/pull/1994)
diff --git a/consensus_encoding/tests/decode.rs b/consensus_encoding/tests/decode.rs
index b1c0fed9..32670e27 100644
--- a/consensus_encoding/tests/decode.rs
+++ b/consensus_encoding/tests/decode.rs
@@ -86,7 +86,7 @@ fn decode_array_empty_slice_push() {
#[test]
fn decode_decoder2_state_transitions() {
- // Test the state transition point boundry in Decoder2.
+ // Test the state transition point boundary in Decoder2.
let mut decoder: Decoder2<ArrayDecoder<2>, ArrayDecoder<3>> =
Decoder2::new(ArrayDecoder::<2>::new(), ArrayDecoder::<3>::new());
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.