consensus_encoding, primitives, units: follow rust doc title convention
What the developer wrote
Authored by Nick Johnson
consensus_encoding, primitives, units: follow rust doc title convention
Follow the standard H1 title convention from the rust standard library.
What changed, and why it matters
This commit only rewrites the top-of-file documentation headings in three Rust library crates to follow the Rust standard library's H1 title convention. It changes comments, not executable code, so it cannot affect program behavior or security.
No security action needed. Treat as a routine documentation cleanup.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff modifies the inner-doc-comment (//!) titles in consensus_encoding/src/lib.rs, primitives/src/lib.rs, and units/src/lib.rs. No Rust source code, logic, dependencies, or public API signatures are altered. It is a documentation formatting change.
Changed components
consensus_encoding/src/lib.rsprimitives/src/lib.rsunits/src/lib.rsInspect captured patch +3 / −3
diff --git a/consensus_encoding/src/lib.rs b/consensus_encoding/src/lib.rs
index 03a7f4a3..7dd04784 100644
--- a/consensus_encoding/src/lib.rs
+++ b/consensus_encoding/src/lib.rs
@@ -1,6 +1,6 @@
// SPDX-License-Identifier: CC0-1.0
-//! # Rust Bitcoin - consensus encoding and decoding
+//! # Rust Bitcoin Consensus Encoding
//!
//! Traits and utilities for encoding and decoding Bitcoin data types in a
//! consensus-consistent way, using a *sans-I/O* architecture.
diff --git a/primitives/src/lib.rs b/primitives/src/lib.rs
index 2dca4630..59967f4e 100644
--- a/primitives/src/lib.rs
+++ b/primitives/src/lib.rs
@@ -1,6 +1,6 @@
// SPDX-License-Identifier: CC0-1.0
-//! Rust Bitcoin - primitive types
+//! # Rust Bitcoin Primitive Types
//!
//! Primitive data types that are used throughout the [`rust-bitcoin`] ecosystem.
//!
diff --git a/units/src/lib.rs b/units/src/lib.rs
index 36af3f4e..e72009e5 100644
--- a/units/src/lib.rs
+++ b/units/src/lib.rs
@@ -1,6 +1,6 @@
// SPDX-License-Identifier: CC0-1.0
-//! Rust Bitcoin - unit types
+//! # Rust Bitcoin Unit Types
//!
//! This library provides basic types used by the Rust Bitcoin ecosystem.
//!
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.