What the developer wrote
Authored by Nick Johnson
consensus_encoding: fix up doc link
Confrom to C-LINK API conventions.
What changed, and why it matters
This is a one-word documentation fix. A comment that referenced another type was changed from plain text to a proper Rust doc link so that documentation tools can create a clickable link. There is no code behavior change and no security relevance.
No security action needed. This is a routine documentation-only change.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The commit changes a doc comment in consensus_encoding/src/encode/encoders.rs from Encoder2 to [Encoder2], making it a valid intra-doc link per Rust API conventions (C-LINK). The diff is +1/-1 with no executable code modified.
Changed components
consensus_encoding/src/encode/encoders.rs documentation onlyInspect captured patch +1 / −1
diff --git a/consensus_encoding/src/encode/encoders.rs b/consensus_encoding/src/encode/encoders.rs
index e0dccec7..75d93530 100644
--- a/consensus_encoding/src/encode/encoders.rs
+++ b/consensus_encoding/src/encode/encoders.rs
@@ -115,7 +115,7 @@ pub struct SliceEncoder<'e, T: Encodable> {
impl<'e, T: Encodable> SliceEncoder<'e, T> {
/// Constructs an encoder which encodes the slice _without_ adding the length prefix.
///
- /// To encode with a length prefix consider using the `Encoder2`.
+ /// To encode with a length prefix consider using [`Encoder2`].
///
/// E.g, `Encoder2<CompactSizeEncoder, SliceEncoder<'e, Foo>>`.
pub fn without_length_prefix(sl: &'e [T]) -> Self {
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.