docs: fix copy-paste errors in documentation comments
What the developer wrote
Authored by Herobrine
docs: fix copy-paste errors in documentation comments
What changed, and why it matters
This commit fixes two typos in documentation comments. One incorrectly called a private key type an 'extended public key,' and another incorrectly referenced a different struct name in a conversion function's doc comment. These are purely cosmetic comment corrections and do not change any executable code.
No security action needed. This is a documentation-only cleanup commit.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff modifies only doc comments in two Rust source files. In bitcoin/src/bip32.rs, the deprecation doc for ExtendedPrivKey is corrected from ‘extended public key’ to ‘extended private key.’ In units/src/block.rs, the doc comment for TryFrom
Changed components
bitcoin/src/bip32.rs documentationunits/src/block.rs documentationInspect captured patch +2 / −2
diff --git a/bitcoin/src/bip32.rs b/bitcoin/src/bip32.rs
index c8ec0d17..d522b3ba 100644
--- a/bitcoin/src/bip32.rs
+++ b/bitcoin/src/bip32.rs
@@ -32,7 +32,7 @@ const VERSION_BYTES_TESTNETS_PRIVATE: [u8; 4] = [0x04, 0x35, 0x83, 0x94];
#[deprecated(since = "0.31.0", note = "use `Xpub` instead")]
pub type ExtendedPubKey = Xpub;
-/// The old name for xpriv, extended public key.
+/// The old name for xpriv, extended private key.
#[deprecated(since = "0.31.0", note = "use `Xpriv` instead")]
pub type ExtendedPrivKey = Xpriv;
diff --git a/units/src/block.rs b/units/src/block.rs
index 6f9f7dc1..c86facc3 100644
--- a/units/src/block.rs
+++ b/units/src/block.rs
@@ -350,7 +350,7 @@ impl From<absolute::MedianTimePast> for BlockMtp {
impl TryFrom<BlockMtp> for absolute::MedianTimePast {
type Error = absolute::ConversionError;
- /// Converts a [`BlockHeight`] to a [`locktime::absolute::Height`].
+ /// Converts a [`BlockMtp`] to a [`locktime::absolute::MedianTimePast`].
///
/// An absolute locktime MTP has a minimum value of [`absolute::LOCK_TIME_THRESHOLD`],
/// while [`BlockMtp`] may take the full range of `u32`.
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.