Skip to content

Commit

Permalink
Fix missing backticks in doc comments
Browse files Browse the repository at this point in the history
This was leading to rustdocs markdown parser to interpret slices like &[u8] as
& and a link to u8
  • Loading branch information
titaniumtraveler committed Mar 25, 2024
1 parent 3a3f61b commit 840da8e
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion src/lexical/large_powers32.rs
Expand Up @@ -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];
Expand Down
2 changes: 1 addition & 1 deletion src/lexical/large_powers64.rs
Expand Up @@ -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];
Expand Down
2 changes: 1 addition & 1 deletion src/lib.rs
Expand Up @@ -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.
//!
//! ```
Expand Down
2 changes: 1 addition & 1 deletion src/read.rs
Expand Up @@ -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
Expand Down

0 comments on commit 840da8e

Please sign in to comment.