What changed, and why it matters
This commit only updates two documentation comments in a Rust source file. It changes how a type called Header is referenced in doc comments so the generated documentation links correctly. There is no code behavior change, no bug fix, and no security relevance.
No action needed. This is a non-functional documentation-only change.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff modifies two rustdoc comments in p2p/src/message.rs. Each comment previously used an explicit intra-doc link syntax Header and now uses the shorthand [Header]. This is a pure documentation formatting adjustment with no functional impact on the crate.
Changed components
p2p/src/message.rs documentation commentsInspect captured patch +2 / −2
diff --git a/p2p/src/message.rs b/p2p/src/message.rs
index 8a2330cd..c5b05411 100644
--- a/p2p/src/message.rs
+++ b/p2p/src/message.rs
@@ -1545,7 +1545,7 @@ fn v2_command_byte(payload: &NetworkMessage) -> (u8, Option<CommandString>) {
}
}
-/// Network encoded [`Header`](primitives::block::Header) with associated byte for the length of
+/// Network encoded [`Header`] with associated byte for the length of
/// transactions that follow, which is currently always zero.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct NetworkHeader {
@@ -1609,7 +1609,7 @@ impl HeadersMessage {
.all(|(first, second)| first.header.block_hash().eq(&second.header.prev_blockhash))
}
- /// Take the message as an iterator of [`Header`](primitives::block::Header).
+ /// Take the message as an iterator of [`Header`].
pub fn into_headers(self) -> impl Iterator<Item = block::Header> {
self.0.into_iter().map(|network| network.header)
}
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.