Skip to content

Commit

Permalink
Delevel headers in crate-level documentation (#1000)
Browse files Browse the repository at this point in the history
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
  • Loading branch information
jswrenn authored Mar 2, 2024
1 parent 80cdc20 commit de16504
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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:

Expand All @@ -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
Expand Down
8 changes: 4 additions & 4 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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:
//!
Expand All @@ -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
Expand Down

0 comments on commit de16504

Please sign in to comment.