Fix docs: correct push_event behavior on redirect (#4183)

Update the documentation for push_event/3 to correctly reflect that events pushed during a redirect (such as push_navigate/2) are sent to the client before the redirection happens, rather than being discarded.

Author: preciz

lib/phoenix_live_view.ex

@@ -810,8 +810,8 @@ defmodule Phoenix.LiveView do
   handling the given `event`. If you need to scope events, then
   this must be done by namespacing them.
 
-  Events pushed during `push_navigate` are currently discarded,
-  as the LiveView is immediately dismounted.
+  Events pushed during `push_navigate` (or any redirect) are sent to the
+  client before the redirection happens.
 
   ## Hook example
 

lib/phoenix_live_view/utils.ex

@@ -265,10 +265,11 @@ defmodule Phoenix.LiveView.Utils do
   @doc """
   Annotates the changes with the event to be pushed.
 
-  By default, events are dispatched on the JavaScript side only after
-  the current patch is invoked. Therefore, if the LiveView
-  redirects, the events won't be invoked. If the `dispatch: :before` option
-  is passed, this event will be dispatched before patching the DOM.
+  By default, events are dispatched on the JavaScript side after
+  the current patch is invoked. If the LiveView redirects,
+  any pending events are dispatched before the redirection occurs.
+  If the `dispatch: :before` option is passed, this event will be
+  dispatched before patching the DOM.
   """
   def push_event(%Socket{} = socket, event, %{} = payload, opts) do
     opts = Keyword.validate!(opts, [:dispatch])