From 010d5134e8fae35e9e4f179d2929e41a20a93d30 Mon Sep 17 00:00:00 2001 From: Fintan Halpenny Date: Thu, 17 Jul 2025 08:44:54 +0100 Subject: [PATCH] protocol: fix `Frame` docstring The `[T]` and `[I]` are interpretted as links when running `cargo doc`. This table is surrounded in a code fence to prevent this, but also provide a better view of the table when rendered to HTML. --- crates/radicle-protocol/src/wire/frame.rs | 2 ++ 1 file changed, 2 insertions(+) diff --git a/crates/radicle-protocol/src/wire/frame.rs b/crates/radicle-protocol/src/wire/frame.rs index cdf9e3ea..3eb45ffc 100644 --- a/crates/radicle-protocol/src/wire/frame.rs +++ b/crates/radicle-protocol/src/wire/frame.rs @@ -184,6 +184,7 @@ impl TryFrom for StreamKind { /// Protocol frame. /// +/// ```text /// 0 1 2 3 /// 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 /// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ @@ -193,6 +194,7 @@ impl TryFrom for StreamKind { /// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ /// | Data ...| Data (variable size) /// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +/// ``` #[derive(Debug, PartialEq, Eq)] pub struct Frame { /// The protocol version.