consensus_encoding: Pluralize rustdoc title
What changed, and why it matters
This commit only fixes grammar in code comments (changing 'Push' to 'Pushes' and 'Complete' to 'Completes'). It does not change any actual program logic, function behavior, or security properties.
No action required; this is a documentation-only style change with no security relevance.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff modifies three rustdoc/doc comments in consensus_encoding/src/decode/mod.rs and consensus_encoding/src/encode/mod.rs to use third-person singular verb forms. No executable code, type signatures, trait definitions, macros, or control flow are altered. There is no security-relevant change.
Changed components
consensus_encoding/src/decode/mod.rsconsensus_encoding/src/encode/mod.rsInspect captured patch +3 / −3
diff --git a/consensus_encoding/src/decode/mod.rs b/consensus_encoding/src/decode/mod.rs
index 1952e53e..df4063a4 100644
--- a/consensus_encoding/src/decode/mod.rs
+++ b/consensus_encoding/src/decode/mod.rs
@@ -56,7 +56,7 @@ pub trait Decoder: Sized {
/// The error type that this decoder can produce.
type Error;
- /// Push bytes into the decoder, consuming as much as possible.
+ /// Pushes bytes into the decoder, consuming as much as possible.
///
/// The slice reference will be advanced to point to the unconsumed portion.
/// Returns `Ok(true)` if more bytes are needed to complete decoding,
@@ -77,7 +77,7 @@ pub trait Decoder: Sized {
#[track_caller]
fn push_bytes(&mut self, bytes: &mut &[u8]) -> Result<bool, Self::Error>;
- /// Complete the decoding process and return the final result.
+ /// Completes the decoding process and return the final result.
///
/// This consumes the decoder and should be called when no more input
/// data is available.
diff --git a/consensus_encoding/src/encode/mod.rs b/consensus_encoding/src/encode/mod.rs
index 33dc40e0..8363a7f8 100644
--- a/consensus_encoding/src/encode/mod.rs
+++ b/consensus_encoding/src/encode/mod.rs
@@ -83,7 +83,7 @@ macro_rules! encoder_newtype {
#[allow(clippy::type_complexity)]
impl<$lt> $name<$lt> {
- /// Construct a new instance of the newtype encoder.
+ /// Constructs a new instance of the newtype encoder.
pub(crate) const fn new(encoder: $encoder) -> $name<$lt> {
$name(encoder, core::marker::PhantomData)
}
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.