fix: add moduledoc to files missing it :c

mbta · Nov 30, 2023 · da81df7 · da81df7
1 parent 5e4417d
commit da81df7
Show file tree

Hide file tree

Showing 93 changed files with 192 additions and 0 deletions.
diff --git a/lib/api/json_api.ex b/lib/api/json_api.ex
@@ -1,4 +1,6 @@
 defmodule JsonApi.Item do
+  @moduledoc false
+
   defstruct [:type, :id, :attributes, :relationships]
 
   @type t :: %JsonApi.Item{
@@ -10,6 +12,8 @@ defmodule JsonApi.Item do
 end
 
 defmodule JsonApi.Error do
+  @moduledoc false
+
   defstruct [:code, :source, :detail, :meta]
 
   @type t :: %__MODULE__{
@@ -21,6 +25,8 @@ defmodule JsonApi.Error do
 end
 
 defmodule JsonApi do
+  @moduledoc false
+
   defstruct data: []
   @type t :: %JsonApi{data: list(JsonApi.Item.t())}
 

diff --git a/lib/concentrate/data_discrepancy.ex b/lib/concentrate/data_discrepancy.ex
@@ -1,4 +1,6 @@
 defmodule Concentrate.DataDiscrepancy do
+  @moduledoc false
+
   @type t :: %__MODULE__{
           attribute: String.t(),
           sources: [source()]

diff --git a/lib/concentrate/pipeline/stop_time_updates_pipeline.ex b/lib/concentrate/pipeline/stop_time_updates_pipeline.ex
@@ -1,4 +1,6 @@
 defmodule Concentrate.Pipeline.StopTimeUpdatesPipeline do
+  @moduledoc false
+
   @behaviour Concentrate.Pipeline
   alias Concentrate.Pipeline
 

diff --git a/lib/concentrate/pipeline/vehicle_positions_pipeline.ex b/lib/concentrate/pipeline/vehicle_positions_pipeline.ex
@@ -1,4 +1,6 @@
 defmodule Concentrate.Pipeline.VehiclePositionsPipeline do
+  @moduledoc false
+
   @behaviour Concentrate.Pipeline
   alias Concentrate.Pipeline
 

diff --git a/lib/geonames.ex b/lib/geonames.ex
@@ -1,4 +1,6 @@
 defmodule Geonames do
+  @moduledoc false
+
   require Logger
 
   @spec nearest_intersection(String.t(), String.t()) :: String.t() | nil

diff --git a/lib/helpers.ex b/lib/helpers.ex
@@ -1,4 +1,6 @@
 defmodule Helpers do
+  @moduledoc false
+
   @doc """
   Apply a function to all of the values in a map
 

diff --git a/lib/notifications/bridge_status.ex b/lib/notifications/bridge_status.ex
@@ -1,4 +1,6 @@
 defmodule Notifications.BridgeStatus do
+  @moduledoc false
+
   use Ecto.Type
 
   @type t :: :raised | :lowered

diff --git a/lib/notifications/db/block_waiver.ex b/lib/notifications/db/block_waiver.ex
@@ -1,4 +1,6 @@
 defmodule Notifications.Db.BlockWaiver do
+  @moduledoc false
+
   use Ecto.Schema
   import Ecto.Changeset
   alias Notifications.NotificationReason

diff --git a/lib/notifications/db/bridge_movement.ex b/lib/notifications/db/bridge_movement.ex
@@ -1,4 +1,6 @@
 defmodule Notifications.Db.BridgeMovement do
+  @moduledoc false
+
   use Ecto.Schema
   import Ecto.Changeset
 

diff --git a/lib/notifications/db/notification.ex b/lib/notifications/db/notification.ex
@@ -1,4 +1,6 @@
 defmodule Notifications.Db.Notification do
+  @moduledoc false
+
   use Ecto.Schema
   import Ecto.Changeset
 

diff --git a/lib/notifications/db/notification_user.ex b/lib/notifications/db/notification_user.ex
@@ -1,4 +1,6 @@
 defmodule Notifications.Db.NotificationUser do
+  @moduledoc false
+
   use Ecto.Schema
 
   alias Notifications.Db.Notification, as: DbNotification

diff --git a/lib/notifications/notification.ex b/lib/notifications/notification.ex
@@ -1,4 +1,6 @@
 defmodule Notifications.Notification do
+  @moduledoc false
+
   import Skate.Repo
 
   import Ecto.Query

diff --git a/lib/notifications/notification_reason.ex b/lib/notifications/notification_reason.ex
@@ -1,4 +1,6 @@
 defmodule Notifications.NotificationReason do
+  @moduledoc false
+
   use Ecto.Type
 
   @type t ::

diff --git a/lib/notifications/notification_server.ex b/lib/notifications/notification_server.ex
@@ -1,4 +1,6 @@
 defmodule Notifications.NotificationServer do
+  @moduledoc false
+
   use GenServer
 
   alias Notifications.Bridge

diff --git a/lib/notifications/notification_state.ex b/lib/notifications/notification_state.ex
@@ -1,4 +1,6 @@
 defmodule Notifications.NotificationState do
+  @moduledoc false
+
   use Ecto.Type
 
   @type t ::

diff --git a/lib/notifications/supervisor.ex b/lib/notifications/supervisor.ex
@@ -1,4 +1,6 @@
 defmodule Notifications.Supervisor do
+  @moduledoc false
+
   use Supervisor
 
   def start_link([]) do

diff --git a/lib/realtime/alerts_fetcher.ex b/lib/realtime/alerts_fetcher.ex
@@ -1,4 +1,6 @@
 defmodule Realtime.AlertsFetcher do
+  @moduledoc false
+
   use GenServer
   require Logger
   alias Schedule.Route

diff --git a/lib/realtime/crowding.ex b/lib/realtime/crowding.ex
@@ -1,4 +1,6 @@
 defmodule Realtime.Crowding do
+  @moduledoc false
+
   @type t :: %__MODULE__{
           load: non_neg_integer() | nil,
           capacity: non_neg_integer() | nil,

diff --git a/lib/realtime/data_status.ex b/lib/realtime/data_status.ex
@@ -1,4 +1,6 @@
 defmodule Realtime.DataStatus do
+  @moduledoc false
+
   alias Realtime.Vehicle
   require Logger
 

diff --git a/lib/realtime/data_status_alerter.ex b/lib/realtime/data_status_alerter.ex
@@ -1,4 +1,6 @@
 defmodule Realtime.DataStatusAlerter do
+  @moduledoc false
+
   use GenServer
   require Logger
 

diff --git a/lib/realtime/ghost.ex b/lib/realtime/ghost.ex
@@ -1,4 +1,6 @@
 defmodule Realtime.Ghost do
+  @moduledoc false
+
   alias Schedule.{AsDirected, Block, Route, Trip}
   alias Schedule.Gtfs.{Direction, RoutePattern, StopTime, Timepoint}
   alias Schedule.Piece

diff --git a/lib/realtime/helpers.ex b/lib/realtime/helpers.ex
@@ -1,4 +1,6 @@
 defmodule Realtime.Helpers do
+  @moduledoc false
+
   @doc """
   Returns the first element that matches the condition, and also the element that appears before it in the list.
 

diff --git a/lib/realtime/route_status.ex b/lib/realtime/route_status.ex
@@ -1,3 +1,5 @@
 defmodule Realtime.RouteStatus do
+  @moduledoc false
+
   @type route_status :: :on_route | :laying_over | :pulling_out
 end
diff --git a/lib/realtime/stop_time_updates_by_trip.ex b/lib/realtime/stop_time_updates_by_trip.ex
@@ -1,4 +1,6 @@
 defmodule Realtime.StopTimeUpdatesByTrip do
+  @moduledoc false
+
   alias Concentrate.StopTimeUpdate
   alias Schedule.Trip
 

diff --git a/lib/realtime/supervisor.ex b/lib/realtime/supervisor.ex
@@ -1,4 +1,6 @@
 defmodule Realtime.Supervisor do
+  @moduledoc false
+
   use Supervisor
 
   def start_link([]) do

diff --git a/lib/realtime/time_period.ex b/lib/realtime/time_period.ex
@@ -1,4 +1,6 @@
 defmodule Realtime.TimePeriod do
+  @moduledoc false
+
   @type t :: %__MODULE__{
           time_period_id: String.t(),
           day_type_id: day_type(),

diff --git a/lib/realtime/timepoint_status.ex b/lib/realtime/timepoint_status.ex
@@ -1,4 +1,6 @@
 defmodule Realtime.TimepointStatus do
+  @moduledoc false
+
   alias Schedule.{Block, Route, Trip}
   alias Schedule.Gtfs.{Direction, RoutePattern, Stop, StopTime}
   alias Schedule.Hastus.Run

diff --git a/lib/realtime/vehicle.ex b/lib/realtime/vehicle.ex
@@ -1,4 +1,6 @@
 defmodule Realtime.Vehicle do
+  @moduledoc false
+
   alias Schedule.Gtfs.Timepoint
   alias Concentrate.{DataDiscrepancy, VehiclePosition}
   alias Schedule.{Block, Route, Trip}

diff --git a/lib/realtime/vehicle_or_ghost.ex b/lib/realtime/vehicle_or_ghost.ex
@@ -1,4 +1,6 @@
 defmodule Realtime.VehicleOrGhost do
+  @moduledoc false
+
   alias Realtime.{Ghost, Server, Vehicle}
 
   @type t :: Vehicle.t() | Ghost.t()

diff --git a/lib/realtime/vehicles.ex b/lib/realtime/vehicles.ex
@@ -1,4 +1,6 @@
 defmodule Realtime.Vehicles do
+  @moduledoc false
+
   alias Realtime.{Ghost, Vehicle, VehicleOrGhost}
   alias Schedule.{Block, Route, Trip}
   alias Schedule.Gtfs.{Direction, Timepoint}

diff --git a/lib/report.ex b/lib/report.ex
@@ -1,4 +1,6 @@
 defmodule Report do
+  @moduledoc false
+
   @doc """
   Exectutes a report against a given repo, returning the results or an error
   """

diff --git a/lib/schedule/as_directed.ex b/lib/schedule/as_directed.ex
@@ -1,4 +1,6 @@
 defmodule Schedule.AsDirected do
+  @moduledoc false
+
   alias Schedule.Hastus.Place
 
   @type t :: %__MODULE__{

diff --git a/lib/schedule/block.ex b/lib/schedule/block.ex
@@ -1,4 +1,6 @@
 defmodule Schedule.Block do
+  @moduledoc false
+
   alias Schedule.AsDirected
   alias Schedule.Gtfs.Service
   alias Schedule.Hastus

diff --git a/lib/schedule/break.ex b/lib/schedule/break.ex
@@ -1,4 +1,6 @@
 defmodule Schedule.Break do
+  @moduledoc false
+
   alias Schedule.Hastus.Activity
   alias Schedule.Hastus.Place
 

diff --git a/lib/schedule/fetcher.ex b/lib/schedule/fetcher.ex
@@ -1,4 +1,6 @@
 defmodule Schedule.Fetcher do
+  @moduledoc false
+
   use GenServer, restart: :transient
   require Logger
 

diff --git a/lib/schedule/garage.ex b/lib/schedule/garage.ex
@@ -1,4 +1,6 @@
 defmodule Schedule.Garage do
+  @moduledoc false
+
   alias Schedule.Gtfs.Route
   alias Schedule.Trip
   require Logger

diff --git a/lib/schedule/gtfs/calendar.ex b/lib/schedule/gtfs/calendar.ex
@@ -1,4 +1,6 @@
 defmodule Schedule.Gtfs.Calendar do
+  @moduledoc false
+
   alias Schedule.Csv
   alias Schedule.Gtfs.Service
 

diff --git a/lib/schedule/gtfs/direction.ex b/lib/schedule/gtfs/direction.ex
@@ -1,4 +1,6 @@
 defmodule Schedule.Gtfs.Direction do
+  @moduledoc false
+
   alias Schedule.Csv
   alias Schedule.Gtfs.Route
 

diff --git a/lib/schedule/gtfs/feed_info.ex b/lib/schedule/gtfs/feed_info.ex
@@ -1,4 +1,6 @@
 defmodule Schedule.Gtfs.FeedInfo do
+  @moduledoc false
+
   require Logger
 
   alias Schedule.Csv

diff --git a/lib/schedule/gtfs/route.ex b/lib/schedule/gtfs/route.ex
@@ -1,4 +1,6 @@
 defmodule Schedule.Gtfs.Route do
+  @moduledoc false
+
   alias Schedule.{Csv, Data, Garage}
 
   @type id :: Schedule.Route.id()

diff --git a/lib/schedule/gtfs/route_pattern.ex b/lib/schedule/gtfs/route_pattern.ex
@@ -1,4 +1,6 @@
 defmodule Schedule.Gtfs.RoutePattern do
+  @moduledoc false
+
   alias Schedule.Csv
   alias Schedule.Gtfs.Direction
   alias Schedule.Gtfs.Route

diff --git a/lib/schedule/gtfs/service.ex b/lib/schedule/gtfs/service.ex
@@ -1,3 +1,5 @@
 defmodule Schedule.Gtfs.Service do
+  @moduledoc false
+
   @type id :: String.t()
 end
diff --git a/lib/schedule/gtfs/shape.ex b/lib/schedule/gtfs/shape.ex
@@ -1,4 +1,6 @@
 defmodule Schedule.Gtfs.Shape do
+  @moduledoc false
+
   alias Schedule.Csv
   alias Schedule.Gtfs.Shape.Point
 
@@ -44,6 +46,8 @@ defmodule Schedule.Gtfs.Shape do
 end
 
 defmodule Schedule.Gtfs.Shape.Point do
+  @moduledoc false
+
   alias Schedule.Csv
   alias Schedule.Gtfs.Shape
 

diff --git a/lib/schedule/gtfs/stop.ex b/lib/schedule/gtfs/stop.ex
@@ -1,4 +1,6 @@
 defmodule Schedule.Gtfs.Stop do
+  @moduledoc false
+
   alias Schedule.Csv
   alias Schedule.Gtfs.{Route, RoutePattern, StopTime}
 

diff --git a/lib/schedule/gtfs/timepoint.ex b/lib/schedule/gtfs/timepoint.ex
@@ -1,4 +1,6 @@
 defmodule Schedule.Gtfs.Timepoint do
+  @moduledoc false
+
   alias Schedule.Csv
 
   @garage_names_by_id %{

diff --git a/lib/schedule/gtfs/trip.ex b/lib/schedule/gtfs/trip.ex
@@ -1,4 +1,6 @@
 defmodule Schedule.Gtfs.Trip do
+  @moduledoc false
+
   alias Schedule.Block
   alias Schedule.Csv
   alias Schedule.Gtfs.{Direction, Route, RoutePattern, Service, Shape}

diff --git a/lib/schedule/hastus/activity.ex b/lib/schedule/hastus/activity.ex
@@ -1,4 +1,6 @@
 defmodule Schedule.Hastus.Activity do
+  @moduledoc false
+
   alias Schedule.AsDirected
   alias Schedule.Block
   alias Schedule.Break

diff --git a/lib/schedule/hastus/place.ex b/lib/schedule/hastus/place.ex
@@ -1,4 +1,6 @@
 defmodule Schedule.Hastus.Place do
+  @moduledoc false
+
   @type id :: String.t()
 
   @spec map_input_place_id(id) :: id

diff --git a/lib/schedule/hastus/run.ex b/lib/schedule/hastus/run.ex
@@ -1,4 +1,6 @@
 defmodule Schedule.Hastus.Run do
+  @moduledoc false
+
   alias Schedule.Hastus.Schedule
 
   @type id :: String.t()

diff --git a/lib/schedule/hastus/trip.ex b/lib/schedule/hastus/trip.ex
@@ -1,4 +1,6 @@
 defmodule Schedule.Hastus.Trip do
+  @moduledoc false
+
   alias Schedule.Csv
   alias Schedule.{Block, Route, Trip}
   alias Schedule.Hastus.{Place, Run, Schedule}

diff --git a/lib/schedule/helpers.ex b/lib/schedule/helpers.ex
@@ -1,4 +1,6 @@
 defmodule Schedule.Helpers do
+  @moduledoc false
+
   @doc """
   Returns a single list that attempts to keep items in order
 

diff --git a/lib/schedule/piece.ex b/lib/schedule/piece.ex
@@ -1,4 +1,6 @@
 defmodule Schedule.Piece do
+  @moduledoc false
+
   alias Schedule.Block
   alias Schedule.Hastus
   alias Schedule.Hastus.Place

diff --git a/lib/schedule/route.ex b/lib/schedule/route.ex
@@ -1,4 +1,6 @@
 defmodule Schedule.Route do
+  @moduledoc false
+
   @type id :: String.t()
   @type by_id(value) :: %{id() => value}
 end