From b369e9c4ac2e720a12dd83abb5dc183b117830bc Mon Sep 17 00:00:00 2001 From: Jack Wrenn Date: Sat, 2 Mar 2024 03:57:13 +0000 Subject: [PATCH] Delevel headers in crate-level documentation In #983 we utilized H6 level headers is our overview documentation. Unfortunately, the readme generator up-levels all headers by one degree, and there's no such thing as an H7. Closes #998 --- README.md | 8 ++++---- src/lib.rs | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 53e1ca50e7..fa2a5351c7 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ so you don't have to. ## Overview -####### Conversion Traits +###### Conversion Traits Zerocopy provides four derivable traits for zero-cost conversions: - `TryFromBytes` indicates that a type may safely be converted from @@ -37,7 +37,7 @@ Zerocopy provides four derivable traits for zero-cost conversions: - `IntoBytes` indicates that a type may safely be converted *to* a byte sequence -####### Marker Traits +###### Marker Traits Zerocopy provides three derivable marker traits that do not provide any functionality themselves, but are required to call certain methods provided @@ -49,7 +49,7 @@ by the conversion traits: You should generally derive these marker traits whenever possible. -####### Conversion Macros +###### Conversion Macros Zerocopy provides three macros for safe, zero-cost casting between types: @@ -64,7 +64,7 @@ These macros perform *compile-time* alignment and size checks, but cannot be used in generic contexts. For generic conversions, use the methods defined by the [conversion traits](#conversion-traits). -####### Byteorder-Aware Numerics +###### Byteorder-Aware Numerics Zerocopy provides byte-order aware integer types that support these conversions; see the `byteorder` module. These types are especially useful diff --git a/src/lib.rs b/src/lib.rs index 6b8502063b..12d816bf3a 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -25,7 +25,7 @@ //! //! # Overview //! -//! ###### Conversion Traits +//! ##### Conversion Traits //! //! Zerocopy provides four derivable traits for zero-cost conversions: //! - [`TryFromBytes`] indicates that a type may safely be converted from @@ -37,7 +37,7 @@ //! - [`IntoBytes`] indicates that a type may safely be converted *to* a byte //! sequence //! -//! ###### Marker Traits +//! ##### Marker Traits //! //! Zerocopy provides three derivable marker traits that do not provide any //! functionality themselves, but are required to call certain methods provided @@ -49,7 +49,7 @@ //! //! You should generally derive these marker traits whenever possible. //! -//! ###### Conversion Macros +//! ##### Conversion Macros //! //! Zerocopy provides three macros for safe, zero-cost casting between types: //! @@ -64,7 +64,7 @@ //! used in generic contexts. For generic conversions, use the methods defined //! by the [conversion traits](#conversion-traits). //! -//! ###### Byteorder-Aware Numerics +//! ##### Byteorder-Aware Numerics //! //! Zerocopy provides byte-order aware integer types that support these //! conversions; see the [`byteorder`] module. These types are especially useful