From c72ee6eca90ae716c06d1f80eb19b6aed24ae9b8 Mon Sep 17 00:00:00 2001
From: David Pedersen <david.pdrsn@gmail.com>
Date: Wed, 10 Aug 2022 12:40:31 +0200
Subject: [PATCH] Document browsers ignoring SSE events without data fields
 (#1242)

* Document browsers ignoring SSE events without data fields

* only add note on `Event::data`
---
 axum/src/response/sse.rs | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/axum/src/response/sse.rs b/axum/src/response/sse.rs
index 9013d4f7..1636dea5 100644
--- a/axum/src/response/sse.rs
+++ b/axum/src/response/sse.rs
@@ -175,12 +175,14 @@ impl Event {
     ///
     /// This corresponds to [`MessageEvent`'s data field].
     ///
-    /// [`MessageEvent`'s data field]: https://developer.mozilla.org/en-US/docs/Web/API/MessageEvent/data
+    /// Note that events with an empty data field will be ignored by the browser.
     ///
     /// # Panics
     ///
     /// - Panics if `data` contains any carriage returns, as they cannot be transmitted over SSE.
     /// - Panics if `data` or `json_data` have already been called.
+    ///
+    /// [`MessageEvent`'s data field]: https://developer.mozilla.org/en-US/docs/Web/API/MessageEvent/data
     pub fn data<T>(mut self, data: T) -> Event
     where
         T: AsRef<str>,
@@ -202,11 +204,11 @@ impl Event {
     ///
     /// This corresponds to [`MessageEvent`'s data field].
     ///
-    /// [`MessageEvent`'s data field]: https://developer.mozilla.org/en-US/docs/Web/API/MessageEvent/data
-    ///
     /// # Panics
     ///
     /// Panics if `data` or `json_data` have already been called.
+    ///
+    /// [`MessageEvent`'s data field]: https://developer.mozilla.org/en-US/docs/Web/API/MessageEvent/data
     #[cfg(feature = "json")]
     pub fn json_data<T>(mut self, data: T) -> serde_json::Result<Event>
     where