From 1ba319a93538ab6a1c1a1b37488983818df716fc Mon Sep 17 00:00:00 2001 From: Tau Date: Fri, 15 Mar 2024 21:08:04 +0100 Subject: [PATCH] Fix latency docs for viewing on GH --- doc/latency-rustdoc.md | 21 +++++++++++++++++++++ doc/latency.md | 9 ++++----- src/lib.rs | 2 +- 3 files changed, 26 insertions(+), 6 deletions(-) create mode 100644 doc/latency-rustdoc.md diff --git a/doc/latency-rustdoc.md b/doc/latency-rustdoc.md new file mode 100644 index 0000000..5f395da --- /dev/null +++ b/doc/latency-rustdoc.md @@ -0,0 +1,21 @@ +# Latency Measurements +Measurements generated using `examples/benchmark`: +```shell +cargo run --release -p benchmark '' +``` + +## Fast Terminals + + + + + +## Slow Terminals + + + + + + +**ℹ️ Note:** +The macOS terminals were not tested on the same machine as the Linux terminals. diff --git a/doc/latency.md b/doc/latency.md index 43a9d56..a1fbfe6 100644 --- a/doc/latency.md +++ b/doc/latency.md @@ -6,15 +6,14 @@ cargo run --release -p benchmark '' ## Fast Terminals - - + + ## Slow Terminals - - - + + **ℹ️ Note:** diff --git a/src/lib.rs b/src/lib.rs index a00e427..5a5171c 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -107,7 +107,7 @@ pub mod terminal_survey {} pub mod windows_unsupported {} #[cfg(feature = "docs")] -#[doc = include_str!("../doc/latency.md")] +#[doc = include_str!("../doc/latency-rustdoc.md")] pub mod latency {} #[cfg(doctest)]