Skip to content

Commit

Permalink
docs(pnet): use backticks for referencing types (backport #3252) (#3450)
Browse files Browse the repository at this point in the history
docs(pnet): use backticks for referencing types (#3252)

With the update to Rust 1.66, rustdoc is (rightfully) complaining about us writing bad HTML. `<u8>` is interpreted as an unclosed HTML tag. See https://github.com/libp2p/rust-libp2p/actions/runs/3708901592/jobs/6286942010#step:6:1380 for example.

(cherry picked from commit e960aab)

Co-authored-by: Thomas Eizinger <[email protected]>
  • Loading branch information
mergify[bot] and thomaseizinger authored Feb 10, 2023
1 parent a4c0bcd commit 8e34424
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion transports/pnet/src/crypt_writer.rs
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ impl<W: AsyncWrite> CryptWriter<W> {
}
}

/// Write the contents of a Vec<u8> into an AsyncWrite.
/// Write the contents of a [`Vec<u8>`] into an [`AsyncWrite`].
///
/// The handling 0 byte progress and the Interrupted error was taken from BufWriter in async_std.
///
Expand Down

0 comments on commit 8e34424

Please sign in to comment.