Fix documentation typo for Address::p2tr_tweaked
What the developer wrote
Authored by Nadav Ivgi
Fix documentation typo for Address::p2tr_tweaked
What changed, and why it matters
This commit fixes a single-word typo in a documentation comment. The word 'pre-tweaked' was changed to 'tweaked' to accurately describe the function's parameter. There is no code change and no security impact.
No action required; this is a documentation-only typo fix with no security relevance.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff modifies only a doc comment in bitcoin/src/address/mod.rs for Address::p2tr_tweaked. The function accepts a TweakedPublicKey, and the corrected wording aligns the documentation with the actual API semantics. No executable code, logic, or cryptographic handling was altered.
Changed components
bitcoin/src/address/mod.rs documentation commentInspect captured patch +1 / −1
diff --git a/bitcoin/src/address/mod.rs b/bitcoin/src/address/mod.rs
index 709d108e..844c62a5 100644
--- a/bitcoin/src/address/mod.rs
+++ b/bitcoin/src/address/mod.rs
@@ -584,7 +584,7 @@ impl Address {
Self::from_witness_program(program, hrp)
}
- /// Constructs a new pay-to-Taproot (P2TR) [`Address`] from a pre-tweaked output key.
+ /// Constructs a new pay-to-Taproot (P2TR) [`Address`] from a tweaked output key.
pub fn p2tr_tweaked(output_key: TweakedPublicKey, hrp: impl Into<KnownHrp>) -> Self {
let program = WitnessProgram::p2tr_tweaked(output_key);
Self::from_witness_program(program, hrp)
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.