From e912a9204c3b8ffb3321cb730bc192dafdd3297e Mon Sep 17 00:00:00 2001
From: Avi Dessauer <avi.the.coder@gmail.com>
Date: Fri, 3 Jan 2025 21:27:08 -0800
Subject: [PATCH] Clarify `FragmentCollectorRead::read_frame(send_fn)` closure
 documentation (#89)

---
 src/fragment.rs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/fragment.rs b/src/fragment.rs
index 937eeaa..faf260a 100644
--- a/src/fragment.rs
+++ b/src/fragment.rs
@@ -168,6 +168,10 @@ impl<'f, S> FragmentCollectorRead<S> {
   /// Reads a WebSocket frame, collecting fragmented messages until the final frame is received and returns the completed message.
   ///
   /// Text frames payload is guaranteed to be valid UTF-8.
+  ///
+  /// # Arguments
+  ///
+  /// * `send_fn`: Closure must ensure frames are sent by write side of split WebSocket to correctly implement auto-close and auto-pong.
   pub async fn read_frame<R, E>(
     &mut self,
     send_fn: &mut impl FnMut(Frame<'f>) -> R,