From 7c3c8ab97713a1d8bd9d856f3d730e48cf82f610 Mon Sep 17 00:00:00 2001
From: Matthias Seitz <matthias.seitz@outlook.de>
Date: Sun, 2 Jul 2023 12:52:02 +0200
Subject: [PATCH] docs: add additional context to internal tracing error
 (#3531)

---
 crates/rpc/rpc/src/eth/error.rs | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/crates/rpc/rpc/src/eth/error.rs b/crates/rpc/rpc/src/eth/error.rs
index f7bf257007..1818f4aea8 100644
--- a/crates/rpc/rpc/src/eth/error.rs
+++ b/crates/rpc/rpc/src/eth/error.rs
@@ -68,6 +68,9 @@ pub enum EthApiError {
     #[error("invalid reward percentiles")]
     InvalidRewardPercentiles,
     /// Error thrown when a spawned tracing task failed to deliver an anticipated response.
+    ///
+    /// This only happens if the tracing task panics and is aborted before it can return a response
+    /// back to the request handler.
     #[error("internal error while tracing")]
     InternalTracingError,
     /// Error thrown when a spawned blocking task failed to deliver an anticipated response.