Add newline after heading on new_witness_program_unchecked
What the developer wrote
Authored by Mitchell Bagot
Add newline after heading on new_witness_program_unchecked
Function doccomments should always have a blank line between the first
heading line and any subsequent comment content. While the
new_witness_program_unchecked functions are not public, they might as
well be adjusted to suit this standard.
Add newline under the heading lines of each instance of
new_witness_program_unchecked.
What changed, and why it matters
This commit only adds blank lines inside documentation comments for three internal helper functions. It changes no executable code, no APIs, and no behavior, so it has no security relevance.
No action required; this is a non-functional documentation formatting change.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff inserts a single blank doc-comment line (///) immediately after the first summary line of new_witness_program_unchecked in three Rust source files. These are private/pub(crate) helpers, and the change is purely a Rustdoc style fix. No logic, types, visibility, or safety properties are modified.
Changed components
addresses/src/lib.rsbitcoin/src/blockdata/script/mod.rsprimitives/src/script/mod.rsInspect captured patch +3 / −0
diff --git a/addresses/src/lib.rs b/addresses/src/lib.rs
index c2aa966d..bc940343 100644
--- a/addresses/src/lib.rs
+++ b/addresses/src/lib.rs
@@ -120,6 +120,7 @@ mod sealed {
}
/// Generates P2WSH-type of scriptPubkey with a given [`WitnessVersion`] and the program bytes.
+///
/// Does not do any checks on version or program length.
///
/// Convenience method used by `new_p2a`, `new_p2wpkh`, `new_p2wsh`, `new_p2tr`, and `new_p2tr_tweaked`.
diff --git a/bitcoin/src/blockdata/script/mod.rs b/bitcoin/src/blockdata/script/mod.rs
index e6ac5d32..adbb7589 100644
--- a/bitcoin/src/blockdata/script/mod.rs
+++ b/bitcoin/src/blockdata/script/mod.rs
@@ -202,6 +202,7 @@ fn opcode_to_verify(opcode: Option<Opcode>) -> Option<Opcode> {
}
/// Generates P2WSH-type of scriptPubkey with a given [`WitnessVersion`] and the program bytes.
+///
/// Does not do any checks on version or program length.
///
/// Convenience method used by `new_p2a`, `new_p2wpkh`, `new_p2wsh`, `new_p2tr`, and `new_p2tr_tweaked`.
diff --git a/primitives/src/script/mod.rs b/primitives/src/script/mod.rs
index 70fde405..7d78ce5b 100644
--- a/primitives/src/script/mod.rs
+++ b/primitives/src/script/mod.rs
@@ -94,6 +94,7 @@ pub const MAX_WITNESS_SCRIPT_SIZE: usize = 10_000;
pub(crate) const P2A_PROGRAM: [u8; 2] = [78, 115];
/// Generates P2WSH-type of scriptPubkey with a given [`WitnessVersion`] and the program bytes.
+///
/// Does not do any checks on version or program length.
///
/// Convenience method used by `new_p2a`, `new_p2wpkh`, `new_p2wsh`, `new_p2tr`, and `new_p2tr_tweaked`.
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.