Document LiveView controller example requiring Phoenix controller (#1672

)
phoenixframework · Oct 14, 2021 · afdee17 · afdee17
1 parent 8b4b80b
commit afdee17
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 4 deletions.
diff --git a/lib/phoenix_live_view/controller.ex b/lib/phoenix_live_view/controller.ex
@@ -19,8 +19,11 @@ defmodule Phoenix.LiveView.Controller do
   ## Examples
 
       defmodule ThermostatController do
-        ...
-        import Phoenix.LiveView.Controller
+        use MyAppWeb, :controller
+
+        # "use MyAppWeb, :controller" should import Phoenix.LiveView.Controller.
+        # If it does not, you can either import it there or uncomment the line below:
+        # import Phoenix.LiveView.Controller
 
         def show(conn, %{"id" => thermostat_id}) do
           live_render(conn, ThermostatLive, session: %{

diff --git a/lib/phoenix_live_view/router.ex b/lib/phoenix_live_view/router.ex
@@ -301,7 +301,7 @@ defmodule Phoenix.LiveView.Router do
 
   ## Examples
 
-      defmodule AppWeb.Router do
+      defmodule MyAppWeb.Router do
         use LiveGenWeb, :router
         import Phoenix.LiveView.Router
 

diff --git a/lib/phoenix_live_view/test/live_view_test.ex b/lib/phoenix_live_view/test/live_view_test.ex
@@ -213,7 +213,7 @@ defmodule Phoenix.LiveViewTest do
   ## Examples
 
       {:ok, view, html} =
-        live_isolated(conn, AppWeb.ClockLive, session: %{"tz" => "EST"})
+        live_isolated(conn, MyAppWeb.ClockLive, session: %{"tz" => "EST"})
 
   Use `put_connect_params/2` to put connect params for a call to
   `Phoenix.LiveView.get_connect_params/1` in `c:Phoenix.LiveView.mount/3`: