Add moduledocs for the new routers, update the split router docs

oestrich · Mar 24, 2019 · 04bf3d1 · 04bf3d1
1 parent a4bf958
commit 04bf3d1
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 1 deletion.
diff --git a/lib/web/routers/client_router.ex b/lib/web/routers/client_router.ex
@@ -1,4 +1,8 @@
 defmodule Web.ClientRouter do
+  @moduledoc """
+  Router for client sites
+  """
+
   use Web, :router
 
   pipeline :browser do

diff --git a/lib/web/routers/hosted_router.ex b/lib/web/routers/hosted_router.ex
@@ -1,4 +1,8 @@
 defmodule Web.HostedRouter do
+  @moduledoc """
+  Router for hosted sites
+  """
+
   use Web, :router
 
   pipeline :browser do

diff --git a/lib/web/routers/split_router.ex b/lib/web/routers/split_router.ex
@@ -1,6 +1,6 @@
 defmodule Web.SplitRouter do
   @moduledoc """
-  Validate the host matches the configured grapevine host
+  Select the proper router based on the host header
   """
 
   import Plug.Conn