From 840da8e89241d46482c40038d3acdb6745ed4f05 Mon Sep 17 00:00:00 2001 From: Jon Heinritz Date: Mon, 25 Mar 2024 09:06:15 +0100 Subject: [PATCH] Fix missing backticks in doc comments This was leading to rustdocs markdown parser to interpret slices like &[u8] as & and a link to u8 --- README.md | 2 +- src/lexical/large_powers32.rs | 2 +- src/lexical/large_powers64.rs | 2 +- src/lib.rs | 2 +- src/read.rs | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a3ba288f1..be70b7b06 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,7 @@ enum Value { A string of JSON data can be parsed into a `serde_json::Value` by the [`serde_json::from_str`][from_str] function. There is also -[`from_slice`][from_slice] for parsing from a byte slice &\[u8\] and +[`from_slice`][from_slice] for parsing from a byte slice `&[u8]` and [`from_reader`][from_reader] for parsing from any `io::Read` like a File or a TCP stream. diff --git a/src/lexical/large_powers32.rs b/src/lexical/large_powers32.rs index 799119726..eb8582f5f 100644 --- a/src/lexical/large_powers32.rs +++ b/src/lexical/large_powers32.rs @@ -2,7 +2,7 @@ //! Precalculated large powers for 32-bit limbs. -/// Large powers (&[u32]) for base5 operations. +/// Large powers (`&[u32]`) for base5 operations. const POW5_1: [u32; 1] = [5]; const POW5_2: [u32; 1] = [25]; const POW5_3: [u32; 1] = [625]; diff --git a/src/lexical/large_powers64.rs b/src/lexical/large_powers64.rs index ee3656108..96554eac1 100644 --- a/src/lexical/large_powers64.rs +++ b/src/lexical/large_powers64.rs @@ -2,7 +2,7 @@ //! Precalculated large powers for 64-bit limbs. -/// Large powers (&[u64]) for base5 operations. +/// Large powers (`&[u64]`) for base5 operations. const POW5_1: [u64; 1] = [5]; const POW5_2: [u64; 1] = [25]; const POW5_3: [u64; 1] = [625]; diff --git a/src/lib.rs b/src/lib.rs index f10bedb1c..da0da469f 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -56,7 +56,7 @@ //! //! A string of JSON data can be parsed into a `serde_json::Value` by the //! [`serde_json::from_str`][from_str] function. There is also [`from_slice`] -//! for parsing from a byte slice &\[u8\] and [`from_reader`] for parsing from +//! for parsing from a byte slice `&[u8]` and [`from_reader`] for parsing from //! any `io::Read` like a File or a TCP stream. //! //! ``` diff --git a/src/read.rs b/src/read.rs index 06ac907e2..a426911c7 100644 --- a/src/read.rs +++ b/src/read.rs @@ -20,7 +20,7 @@ use alloc::string::String; use serde::de::Visitor; /// Trait used by the deserializer for iterating over input. This is manually -/// "specialized" for iterating over &[u8]. Once feature(specialization) is +/// "specialized" for iterating over `&[u8]`. Once feature(specialization) is /// stable we can use actual specialization. /// /// This trait is sealed and cannot be implemented for types outside of