Merge rust-bitcoin/rust-bitcoin#6976: Fixed Typo Errors to enhance readability within the codebase
What the developer wrote
Authored by Andrew Poelstra
Merge rust-bitcoin/rust-bitcoin#6976: Fixed Typo Errors to enhance readability within the codebase
59360d8d0ae497c4dd50fbcf572acace402b5f95 fixed more typo errors to further enhance readbility within the codebase (Jaydbrown)
Pull request description:
In learning and reading the codebase, i noticed some typo errors which affected my reading and decided to fix it so future readers don't suffer the same plight.
This changes cover typo in modules accross
- Bitcoin; pow.rs file,
- p2p; message-compact-blocks.rs file,
- ChaCha-Poly; Neon.rs file.
and alot others.
ACKs for top commit:
Abeeujah:
ACK 59360d8d0ae497c4dd50fbcf572acace402b5f95
Kixunil:
ACK 59360d8d0ae497c4dd50fbcf572acace402b5f95
apoelstra:
ACK 59360d8d0ae497c4dd50fbcf572acace402b5f95; successfully ran local tests
Tree-SHA512: daf98eab209cc4b7bc8ab47106cc3dd00ced01cca82566baaf095ab1ff17d8a8c228141a7c7ee9c0d90338637764239552b3e08c45b05cde598b763ac9b9e84b
What changed, and why it matters
This commit fixes five spelling mistakes in comments and documentation across the rust-bitcoin codebase. None of the changes alter program logic, data handling, or behavior. They only improve readability of text that is ignored by the compiler.
No security action needed. Treat as a normal documentation/comment cleanup merge.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff contains five typo corrections in human-readable strings/comments: ‘secuity’ → ‘security’ in CHANGELOG.md, ‘tyoe’ → ‘type’ in a sighash.rs comment, ‘paramter’ → ‘parameter’ in pow.rs rustdoc, ‘interleved/instructions/independly’ → ‘interleaved/instructions/independently’ in a neon.rs comment, and ‘occuring’ → ‘occurring’ in message_compact_blocks.rs rustdoc. No executable code, type signatures, constants, cryptographic operations, or protocol parsing logic was modified.
Changed components
bitcoin/CHANGELOG.mdbitcoin/src/crypto/sighash.rsbitcoin/src/pow.rschacha20_poly1305/src/chacha20/neon.rsp2p/src/message_compact_blocks.rsInspect captured patch +5 / −5
### bitcoin/CHANGELOG.md
@@ -177,7 +177,7 @@ Exposes the new stabilized encoding library through the optional `encoding` feat
**Bump the MSRV to Rust 1.74.0**
Note the version number jump. We jumped to `v0.32.100` when doing the MSRV bump so as to
-leave room for a bunch of secuity releases up to this number if needed.
+leave room for a bunch of security releases up to this number if needed.
- Our primary users (BDK and LDK) are at 1.85 already well ahead of `1.74`.
- We would like to deliver the new sans-IO `consensus_encoding` crate in a point release.
### bitcoin/src/crypto/sighash.rs
@@ -311,7 +311,7 @@ impl SplitAnyoneCanPay for EcdsaSighashType {
SinglePlusAnyoneCanPay => (Single, true),
NonStandard(n) => {
let n = n.to_u32();
- // Check sighash tyoe
+ // Check sighash type
let sighash_type = match n & 0x1f {
0x02 => None,
0x03 => Single,
### bitcoin/src/pow.rs
@@ -69,7 +69,7 @@ internal_macros::define_extension_trait! {
/// alternatively, it will take, again on average, ~6.6 million times as many hashes to find a
/// valid block.
///
- /// Values for the `max_target` paramter can be taken from const values on [`Target`]
+ /// Values for the `max_target` parameter can be taken from const values on [`Target`]
/// (e.g. [`Target::MAX_ATTAINABLE_MAINNET`]).
///
/// # Note
### chacha20_poly1305/src/chacha20/neon.rs
@@ -232,7 +232,7 @@ pub(super) fn apply_8_blocks(
) {
// This function is identical to the 4 block case, however two
// separate working states are mutated. The function calls are
- // interleved so Neon instuctions can execute independly.
+ // interleaved so Neon instructions can execute independently.
// SAFETY: Neon intrinsics are gated by target feature `neon`.
unsafe {
// Initial state values shared across all 8 blocks,
### p2p/src/message_compact_blocks.rs
@@ -92,7 +92,7 @@ pub mod error {
pub(super) fn invalid_mode() -> Self { Self(SendCmpctDecoderErrorInner::InvalidMode) }
}
- /// Errors occuring when decoding a [`SendCmpct`] message.
+ /// Errors occurring when decoding a [`SendCmpct`] message.
///
/// [`SendCmpct`]: super::SendCmpct
#[derive(Debug, Clone, PartialEq, Eq)]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.