docs: two examples for redirect/2 (#2788)

How to redirect to external url.
phoenixframework · Aug 30, 2023 · c60dc28 · c60dc28
1 parent 8c4fc85
commit c60dc28
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/lib/phoenix_live_view.ex b/lib/phoenix_live_view.ex
@@ -930,6 +930,12 @@ defmodule Phoenix.LiveView do
     * `:to` - the path to redirect to. It must always be a local path
     * `:external` - an external path to redirect to. Either a string
       or `{scheme, url}` to redirect to a custom scheme
+
+  ## Examples
+
+      {:noreply, redirect(socket, to: "/")}
+      {:noreply, redirect(socket, external: "https://example.com")}
+
   """
   def redirect(socket, opts \\ [])