feat:doc: group all Ecto models documentation

should make it easier to find our database related code, and easier to navigate in the documentation
mbta · Sep 23, 2024 · 13cbc8f · 13cbc8f
1 parent 9a0a273
commit 13cbc8f
Show file tree

Hide file tree

Showing 10 changed files with 10 additions and 1 deletion.
diff --git a/lib/notifications/db/block_waiver.ex b/lib/notifications/db/block_waiver.ex
@@ -1,4 +1,5 @@
 defmodule Notifications.Db.BlockWaiver do
+  @moduledoc section: :ecto
   @moduledoc """
   Ecto Model for `block_waivers` Database table
   """

diff --git a/lib/notifications/db/bridge_movement.ex b/lib/notifications/db/bridge_movement.ex
@@ -1,4 +1,5 @@
 defmodule Notifications.Db.BridgeMovement do
+  @moduledoc section: :ecto
   @moduledoc """
   Ecto Model for `bridge_movements` Database table
   """

diff --git a/lib/notifications/db/notification.ex b/lib/notifications/db/notification.ex
@@ -1,4 +1,5 @@
 defmodule Notifications.Db.Notification do
+  @moduledoc section: :ecto
   @moduledoc """
   Ecto Model for `notifications` Database table
   """

diff --git a/lib/notifications/db/notification_user.ex b/lib/notifications/db/notification_user.ex
@@ -1,4 +1,5 @@
 defmodule Notifications.Db.NotificationUser do
+  @moduledoc section: :ecto
   @moduledoc """
   Ecto Model for `notification_users` Database table
   """

diff --git a/lib/skate/detours/db/detour.ex b/lib/skate/detours/db/detour.ex
@@ -1,9 +1,9 @@
 defmodule Skate.Detours.Db.Detour do
+  @moduledoc section: :ecto
   @moduledoc """
   Ecto Model for `detours` Database table
   """
 
-
   use Skate.Schema
   import Ecto.Changeset
 

diff --git a/lib/skate/settings/db/route_tab.ex b/lib/skate/settings/db/route_tab.ex
@@ -1,4 +1,5 @@
 defmodule Skate.Settings.Db.RouteTab do
+  @moduledoc section: :ecto
   @moduledoc """
   Ecto Model for `route_tabs` Database table
   """

diff --git a/lib/skate/settings/db/test_group.ex b/lib/skate/settings/db/test_group.ex
@@ -1,4 +1,5 @@
 defmodule Skate.Settings.Db.TestGroup do
+  @moduledoc section: :ecto
   @moduledoc """
   Ecto Model for `test_groups` Database table
   """

diff --git a/lib/skate/settings/db/test_group_user.ex b/lib/skate/settings/db/test_group_user.ex
@@ -1,4 +1,5 @@
 defmodule Skate.Settings.Db.TestGroupUser do
+  @moduledoc section: :ecto
   @moduledoc """
   Ecto Model for `test_groups_users` Database table
   """

diff --git a/lib/skate/settings/db/user.ex b/lib/skate/settings/db/user.ex
@@ -1,4 +1,5 @@
 defmodule Skate.Settings.Db.User do
+  @moduledoc section: :ecto
   @moduledoc """
   Ecto Model for `users` Database table
   """

diff --git a/lib/skate/settings/db/user_settings.ex b/lib/skate/settings/db/user_settings.ex
@@ -1,4 +1,5 @@
 defmodule Skate.Settings.Db.UserSettings do
+  @moduledoc section: :ecto
   @moduledoc """
   Ecto Model for `user_settings` Database table
   """