doctests: Doctests!

mbta · Sep 25, 2024 · 0a5c2ae · 0a5c2ae
1 parent c231cfb
commit 0a5c2ae
Showing 1 changed file with 43 additions and 33 deletions.
diff --git a/lib/notifications/db/notification.ex b/lib/notifications/db/notification.ex
@@ -101,39 +101,49 @@ defmodule Notifications.Db.Notification do
     `Notifications.Db.Notification`'s and retrieves the Detour's
     associated info.
 
-    ## Example
-
-    The `query` parameter defaults to
-    `Notifications.Db.Notification.Queries.base()`, but can be specified
-    explicitly
-
-        iex> Notifications.Db.Notification.Queries.base()
-        ...> |> Notifications.Db.Notification.Queries.select_detour_info()
-        ...> |> Skate.Repo.all()
-        [
-          %Notifications.Db.Notification{
-            detour: %Notifications.Db.Detour{}
-          },
-          %Notifications.Db.Notification{
-            detour_id: nil,
-            detour: nil
-          },
-          _
-        ]
-
-
-        iex> Notifications.Db.Notification.Queries.select_detour_info()
-        ...> |> Skate.Repo.all()
-        [
-          %Notifications.Db.Notification{
-            detour: %Notifications.Db.Detour{ ... }
-          },
-          %Notifications.Db.Notification{
-            detour_id: nil,
-            detour: nil
-          },
-          _
-        ]
+    ## Examples
+
+    There is a `base` query struct that can be provided at the
+    beginning of a query:
+
+        iex> :detour
+        ...> |> insert()
+        ...> |> Notifications.Notification.create_activated_detour_notification_from_detour()
+        ...>
+        iex> all_detour_notifications =
+        ...>   Notifications.Db.Notification.Queries.base()
+        ...>   |> Notifications.Db.Notification.Queries.select_detour_info()
+        ...>   |> Skate.Repo.all()
+        ...>   |> Skate.Repo.preload(:detour)
+        ...>
+        iex> match?(
+        ...>   [
+        ...>     %Notifications.Db.Notification{
+        ...>       detour: %Notifications.Db.Detour{}
+        ...>     }
+        ...>   ], all_detour_notifications
+        ...> )
+        true
+
+    If `base` is omitted, then it's inferred:
+
+        iex> :detour
+        ...> |> insert()
+        ...> |> Notifications.Notification.create_activated_detour_notification_from_detour()
+        ...>
+        iex> all_detour_notifications =
+        ...>   Notifications.Db.Notification.Queries.select_detour_info()
+        ...>   |> Skate.Repo.all()
+        ...>   |> Skate.Repo.preload(:detour)
+        ...>
+        iex> match?(
+        ...>   [
+        ...>     %Notifications.Db.Notification{
+        ...>       detour: %Notifications.Db.Detour{}
+        ...>     }
+        ...>   ], all_detour_notifications
+        ...> )
+        true
 
     """
     @spec select_detour_info(Ecto.Query.t()) :: Ecto.Query.t()