From da81df76eb9db1560789413a4064f800220b7c62 Mon Sep 17 00:00:00 2001 From: Kayla Firestack Date: Thu, 30 Nov 2023 16:14:58 -0500 Subject: [PATCH] fix: add moduledoc to files missing it :c --- lib/api/json_api.ex | 6 ++++++ lib/concentrate/data_discrepancy.ex | 2 ++ lib/concentrate/pipeline/stop_time_updates_pipeline.ex | 2 ++ lib/concentrate/pipeline/vehicle_positions_pipeline.ex | 2 ++ lib/geonames.ex | 2 ++ lib/helpers.ex | 2 ++ lib/notifications/bridge_status.ex | 2 ++ lib/notifications/db/block_waiver.ex | 2 ++ lib/notifications/db/bridge_movement.ex | 2 ++ lib/notifications/db/notification.ex | 2 ++ lib/notifications/db/notification_user.ex | 2 ++ lib/notifications/notification.ex | 2 ++ lib/notifications/notification_reason.ex | 2 ++ lib/notifications/notification_server.ex | 2 ++ lib/notifications/notification_state.ex | 2 ++ lib/notifications/supervisor.ex | 2 ++ lib/realtime/alerts_fetcher.ex | 2 ++ lib/realtime/crowding.ex | 2 ++ lib/realtime/data_status.ex | 2 ++ lib/realtime/data_status_alerter.ex | 2 ++ lib/realtime/ghost.ex | 2 ++ lib/realtime/helpers.ex | 2 ++ lib/realtime/route_status.ex | 2 ++ lib/realtime/stop_time_updates_by_trip.ex | 2 ++ lib/realtime/supervisor.ex | 2 ++ lib/realtime/time_period.ex | 2 ++ lib/realtime/timepoint_status.ex | 2 ++ lib/realtime/vehicle.ex | 2 ++ lib/realtime/vehicle_or_ghost.ex | 2 ++ lib/realtime/vehicles.ex | 2 ++ lib/report.ex | 2 ++ lib/schedule/as_directed.ex | 2 ++ lib/schedule/block.ex | 2 ++ lib/schedule/break.ex | 2 ++ lib/schedule/fetcher.ex | 2 ++ lib/schedule/garage.ex | 2 ++ lib/schedule/gtfs/calendar.ex | 2 ++ lib/schedule/gtfs/direction.ex | 2 ++ lib/schedule/gtfs/feed_info.ex | 2 ++ lib/schedule/gtfs/route.ex | 2 ++ lib/schedule/gtfs/route_pattern.ex | 2 ++ lib/schedule/gtfs/service.ex | 2 ++ lib/schedule/gtfs/shape.ex | 4 ++++ lib/schedule/gtfs/stop.ex | 2 ++ lib/schedule/gtfs/timepoint.ex | 2 ++ lib/schedule/gtfs/trip.ex | 2 ++ lib/schedule/hastus/activity.ex | 2 ++ lib/schedule/hastus/place.ex | 2 ++ lib/schedule/hastus/run.ex | 2 ++ lib/schedule/hastus/trip.ex | 2 ++ lib/schedule/helpers.ex | 2 ++ lib/schedule/piece.ex | 2 ++ lib/schedule/route.ex | 2 ++ lib/schedule/run.ex | 2 ++ lib/schedule/supervisor.ex | 2 ++ lib/schedule/swing.ex | 2 ++ lib/schedule/timepoint_order.ex | 2 ++ lib/schedule/trip.ex | 2 ++ lib/skate/location_search/aws_location_request.ex | 2 ++ lib/skate/location_search/place.ex | 2 ++ lib/skate/location_search/suggestion.ex | 2 ++ lib/skate/settings/db/route_tab.ex | 2 ++ lib/skate/settings/db/test_group.ex | 2 ++ lib/skate/settings/db/test_group_user.ex | 2 ++ lib/skate/settings/db/user.ex | 2 ++ lib/skate/settings/db/user_settings.ex | 2 ++ lib/skate/settings/ladder_direction.ex | 2 ++ lib/skate/settings/route_tab.ex | 2 ++ lib/skate/settings/test_group.ex | 2 ++ lib/skate/settings/user.ex | 2 ++ lib/skate/settings/user_settings.ex | 2 ++ lib/skate/settings/vehicle_adherence_color.ex | 2 ++ lib/skate/settings/vehicle_label.ex | 2 ++ lib/skate/ueberauth/strategy/fake.ex | 2 ++ lib/skate/warm_up.ex | 2 ++ lib/skate_web/auth_manager.ex | 2 ++ lib/skate_web/auth_manager/error_handler.ex | 2 ++ lib/skate_web/auth_manager/pipeline.ex | 2 ++ lib/skate_web/channels/alerts_channel.ex | 2 ++ lib/skate_web/channels/channel_auth.ex | 2 ++ lib/skate_web/channels/data_status_channel.ex | 2 ++ lib/skate_web/channels/notifications_channel.ex | 2 ++ lib/skate_web/channels/train_vehicles_channel.ex | 2 ++ lib/skate_web/channels/vehicle_channel.ex | 2 ++ lib/skate_web/channels/vehicles_channel.ex | 2 ++ lib/skate_web/channels/vehicles_search_channel.ex | 2 ++ lib/skate_web/ensure_admin_group.ex | 2 ++ lib/skate_web/ensure_environment_access.ex | 2 ++ lib/train_vehicles/parser.ex | 2 ++ lib/train_vehicles/supervisor.ex | 2 ++ lib/train_vehicles/train_vehicle.ex | 2 ++ lib/util/time.ex | 2 ++ test/support/factory.ex | 2 ++ 93 files changed, 192 insertions(+) diff --git a/lib/api/json_api.ex b/lib/api/json_api.ex index 7f5a917a81..d6fee58938 100644 --- 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 index 4165b3c4ab..39c70e4a66 100644 --- 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 index 288a9f4be6..fc1fa1ef82 100644 --- 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 index 255f849c6f..c467c82a14 100644 --- 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 index 486b4214db..40f0baa520 100644 --- 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 index cb4e150280..80f6ddf118 100644 --- 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 index 9a9059ba50..727d18ad0e 100644 --- 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 index 672ae95b11..cc1362982a 100644 --- 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 index 6d0e80e726..5685b95edf 100644 --- 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 index a9b0c09e74..6bd864c381 100644 --- 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 index d71475378f..2ace451f37 100644 --- 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 index 537badc902..6d29c45c13 100644 --- 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 index 0de0ce8b62..ba73bc14df 100644 --- 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 index 2907ff91f1..de616f1bac 100644 --- 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 index 1d34258126..decd67f6a6 100644 --- 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 index 4f4d219640..005cfca12a 100644 --- 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 index 90dd93f5b0..185b27aa37 100644 --- 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 index f12c847f21..897c3eb236 100644 --- 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 index 9b1cacf130..a3b5320a7a 100644 --- 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 index f5d5c8d948..c3540f56d9 100644 --- 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 index 091ebb64a0..3ee69a84f1 100644 --- 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 index 1c355faa65..4671af24f9 100644 --- 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 index 3b49fa30d5..7185227bee 100644 --- 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 index db9a0709f8..53315ae9ae 100644 --- 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 index 646057ea71..14aa916cac 100644 --- 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 index 8040405535..1cef980ef5 100644 --- 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 index cf59a55114..7b2997a4f3 100644 --- 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 index 02b7478c4a..82b7c41500 100644 --- 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 index 24b89986fc..003ea9bcb0 100644 --- 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 index fb682ba35c..5e9ddc919e 100644 --- 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 index c079b53a33..61ea892829 100644 --- 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 index 844357cc01..876fa0247c 100644 --- 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 index 6ef9df58f3..1b6073f6a2 100644 --- 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 index f6a5c1b4e9..6f16b90f91 100644 --- 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 index 7333adb1db..f6a9215b6b 100644 --- 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 index 7e8a293bb7..2c666462e2 100644 --- 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 index 6593769582..e032c8de70 100644 --- 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 index a0f8c56281..9140b4db9c 100644 --- 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 index e7a897ea0b..5aefad3447 100644 --- 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 index f2c2170ef8..cadd58a562 100644 --- 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 index 20c7a4a878..301001a73e 100644 --- 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 index b79cf71fab..0577c6a812 100644 --- 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 index 4ec420c6ef..bab6ed9ae8 100644 --- 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 index 71fab87caf..8be450a681 100644 --- 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 index e61657ed5e..8707c154d8 100644 --- 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 index 2325814b0f..237ea00bc7 100644 --- 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 index 56a83861b0..09d93dadb0 100644 --- 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 index 6bfca12e17..2c5a9ac9e0 100644 --- 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 index d190d167b6..88db0c105b 100644 --- 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 index 98f545acc9..c67cf116f8 100644 --- 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 index 7753c3b81c..26b7f742e8 100644 --- 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 index 9ee89fd981..5fd9c6a830 100644 --- 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 index 05aa3fa5c9..80611ddccc 100644 --- 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 diff --git a/lib/schedule/run.ex b/lib/schedule/run.ex index 4d2fff602c..cc9f7d78c5 100644 --- a/lib/schedule/run.ex +++ b/lib/schedule/run.ex @@ -1,4 +1,6 @@ defmodule Schedule.Run do + @moduledoc false + alias Schedule.Gtfs.Service alias Schedule.Break alias Schedule.Piece diff --git a/lib/schedule/supervisor.ex b/lib/schedule/supervisor.ex index 56063f8c3c..c061281327 100644 --- a/lib/schedule/supervisor.ex +++ b/lib/schedule/supervisor.ex @@ -1,4 +1,6 @@ defmodule Schedule.Supervisor do + @moduledoc false + use Supervisor def start_link([]) do diff --git a/lib/schedule/swing.ex b/lib/schedule/swing.ex index 16326c4107..1330a6dde2 100644 --- a/lib/schedule/swing.ex +++ b/lib/schedule/swing.ex @@ -1,4 +1,6 @@ defmodule Schedule.Swing do + @moduledoc false + alias Schedule.Block alias Schedule.Hastus alias Schedule.Gtfs.Service diff --git a/lib/schedule/timepoint_order.ex b/lib/schedule/timepoint_order.ex index efd8d98ef8..2d580be3db 100644 --- a/lib/schedule/timepoint_order.ex +++ b/lib/schedule/timepoint_order.ex @@ -1,4 +1,6 @@ defmodule Schedule.TimepointOrder do + @moduledoc false + alias Schedule.Gtfs.Direction alias Schedule.Gtfs.Route alias Schedule.Gtfs.RoutePattern diff --git a/lib/schedule/trip.ex b/lib/schedule/trip.ex index 517673051d..e3b38cb75c 100644 --- a/lib/schedule/trip.ex +++ b/lib/schedule/trip.ex @@ -1,4 +1,6 @@ defmodule Schedule.Trip do + @moduledoc false + alias Schedule.AsDirected alias Schedule.Block alias Schedule.Gtfs diff --git a/lib/skate/location_search/aws_location_request.ex b/lib/skate/location_search/aws_location_request.ex index eb578c986b..efa9835369 100644 --- a/lib/skate/location_search/aws_location_request.ex +++ b/lib/skate/location_search/aws_location_request.ex @@ -1,4 +1,6 @@ defmodule Skate.LocationSearch.AwsLocationRequest do + @moduledoc false + alias Skate.LocationSearch.Place alias Skate.LocationSearch.Suggestion diff --git a/lib/skate/location_search/place.ex b/lib/skate/location_search/place.ex index 82e86bb217..0b4a64044c 100644 --- a/lib/skate/location_search/place.ex +++ b/lib/skate/location_search/place.ex @@ -1,4 +1,6 @@ defmodule Skate.LocationSearch.Place do + @moduledoc false + @type id :: String.t() @type t :: %__MODULE__{ diff --git a/lib/skate/location_search/suggestion.ex b/lib/skate/location_search/suggestion.ex index 8c6ecc96a4..f11f76f8fb 100644 --- a/lib/skate/location_search/suggestion.ex +++ b/lib/skate/location_search/suggestion.ex @@ -1,4 +1,6 @@ defmodule Skate.LocationSearch.Suggestion do + @moduledoc false + @type t :: %__MODULE__{ text: String.t(), place_id: String.t() | nil diff --git a/lib/skate/settings/db/route_tab.ex b/lib/skate/settings/db/route_tab.ex index 81239cbcc7..ba669c3c83 100644 --- a/lib/skate/settings/db/route_tab.ex +++ b/lib/skate/settings/db/route_tab.ex @@ -1,4 +1,6 @@ defmodule Skate.Settings.Db.RouteTab do + @moduledoc false + use Ecto.Schema import Ecto.Changeset diff --git a/lib/skate/settings/db/test_group.ex b/lib/skate/settings/db/test_group.ex index 2231d24619..02b84cc786 100644 --- a/lib/skate/settings/db/test_group.ex +++ b/lib/skate/settings/db/test_group.ex @@ -1,4 +1,6 @@ defmodule Skate.Settings.Db.TestGroup do + @moduledoc false + use Ecto.Schema import Ecto.Changeset diff --git a/lib/skate/settings/db/test_group_user.ex b/lib/skate/settings/db/test_group_user.ex index 72a3ca3ada..c7d25d1779 100644 --- a/lib/skate/settings/db/test_group_user.ex +++ b/lib/skate/settings/db/test_group_user.ex @@ -1,4 +1,6 @@ defmodule Skate.Settings.Db.TestGroupUser do + @moduledoc false + use Ecto.Schema import Ecto.Changeset diff --git a/lib/skate/settings/db/user.ex b/lib/skate/settings/db/user.ex index b25ebf15e7..06a94b12aa 100644 --- a/lib/skate/settings/db/user.ex +++ b/lib/skate/settings/db/user.ex @@ -1,4 +1,6 @@ defmodule Skate.Settings.Db.User do + @moduledoc false + use Ecto.Schema import Ecto.Changeset diff --git a/lib/skate/settings/db/user_settings.ex b/lib/skate/settings/db/user_settings.ex index 804d765fb6..e6e6ba8862 100644 --- a/lib/skate/settings/db/user_settings.ex +++ b/lib/skate/settings/db/user_settings.ex @@ -1,4 +1,6 @@ defmodule Skate.Settings.Db.UserSettings do + @moduledoc false + use Ecto.Schema import Ecto.Changeset diff --git a/lib/skate/settings/ladder_direction.ex b/lib/skate/settings/ladder_direction.ex index 9ea8a6a7a5..fb842488ca 100644 --- a/lib/skate/settings/ladder_direction.ex +++ b/lib/skate/settings/ladder_direction.ex @@ -1,4 +1,6 @@ defmodule Skate.Settings.LadderDirection do + @moduledoc false + use Ecto.Type @type t :: 0 | 1 diff --git a/lib/skate/settings/route_tab.ex b/lib/skate/settings/route_tab.ex index 8cb42d171a..7eb34222c2 100644 --- a/lib/skate/settings/route_tab.ex +++ b/lib/skate/settings/route_tab.ex @@ -1,4 +1,6 @@ defmodule Skate.Settings.RouteTab do + @moduledoc false + import Ecto.Query alias Skate.Repo diff --git a/lib/skate/settings/test_group.ex b/lib/skate/settings/test_group.ex index 7eed4a7f97..da0a821639 100644 --- a/lib/skate/settings/test_group.ex +++ b/lib/skate/settings/test_group.ex @@ -1,4 +1,6 @@ defmodule Skate.Settings.TestGroup do + @moduledoc false + alias Skate.Settings.Db.TestGroup, as: DbTestGroup alias Skate.Settings.Db.User, as: DbUser diff --git a/lib/skate/settings/user.ex b/lib/skate/settings/user.ex index 4e3ef794d4..80300231a8 100644 --- a/lib/skate/settings/user.ex +++ b/lib/skate/settings/user.ex @@ -1,4 +1,6 @@ defmodule Skate.Settings.User do + @moduledoc false + alias Skate.Settings.Db.User, as: DbUser import Ecto.Query diff --git a/lib/skate/settings/user_settings.ex b/lib/skate/settings/user_settings.ex index f1b4d28ef9..f4984b6ec3 100644 --- a/lib/skate/settings/user_settings.ex +++ b/lib/skate/settings/user_settings.ex @@ -1,4 +1,6 @@ defmodule Skate.Settings.UserSettings do + @moduledoc false + import Skate.Repo import Ecto.Query diff --git a/lib/skate/settings/vehicle_adherence_color.ex b/lib/skate/settings/vehicle_adherence_color.ex index 0ebe5ef309..f1032e4556 100644 --- a/lib/skate/settings/vehicle_adherence_color.ex +++ b/lib/skate/settings/vehicle_adherence_color.ex @@ -1,4 +1,6 @@ defmodule Skate.Settings.VehicleAdherenceColor do + @moduledoc false + use Ecto.Type @type t :: :early_red | :early_blue diff --git a/lib/skate/settings/vehicle_label.ex b/lib/skate/settings/vehicle_label.ex index fba39de86e..f3db9a3653 100644 --- a/lib/skate/settings/vehicle_label.ex +++ b/lib/skate/settings/vehicle_label.ex @@ -1,4 +1,6 @@ defmodule Skate.Settings.VehicleLabel do + @moduledoc false + use Ecto.Type @type t :: :run_id | :vehicle_id diff --git a/lib/skate/ueberauth/strategy/fake.ex b/lib/skate/ueberauth/strategy/fake.ex index 8191782f04..c652ba0a12 100644 --- a/lib/skate/ueberauth/strategy/fake.ex +++ b/lib/skate/ueberauth/strategy/fake.ex @@ -1,4 +1,6 @@ defmodule Skate.Ueberauth.Strategy.Fake do + @moduledoc false + use Ueberauth.Strategy, ignores_csrf_attack: true @impl Ueberauth.Strategy diff --git a/lib/skate/warm_up.ex b/lib/skate/warm_up.ex index 1150e418c1..b63e42c986 100644 --- a/lib/skate/warm_up.ex +++ b/lib/skate/warm_up.ex @@ -1,4 +1,6 @@ defmodule Skate.WarmUp do + @moduledoc false + use GenServer require Logger diff --git a/lib/skate_web/auth_manager.ex b/lib/skate_web/auth_manager.ex index 99ce6d9dda..7020c42ec4 100644 --- a/lib/skate_web/auth_manager.ex +++ b/lib/skate_web/auth_manager.ex @@ -1,4 +1,6 @@ defmodule SkateWeb.AuthManager do + @moduledoc false + use Guardian, otp_app: :skate alias Skate.Settings.User require Logger diff --git a/lib/skate_web/auth_manager/error_handler.ex b/lib/skate_web/auth_manager/error_handler.ex index 94c5275464..65162b13de 100644 --- a/lib/skate_web/auth_manager/error_handler.ex +++ b/lib/skate_web/auth_manager/error_handler.ex @@ -1,4 +1,6 @@ defmodule SkateWeb.AuthManager.ErrorHandler do + @moduledoc false + import Plug.Conn @behaviour Guardian.Plug.ErrorHandler diff --git a/lib/skate_web/auth_manager/pipeline.ex b/lib/skate_web/auth_manager/pipeline.ex index 28ff82d940..75802c2781 100644 --- a/lib/skate_web/auth_manager/pipeline.ex +++ b/lib/skate_web/auth_manager/pipeline.ex @@ -1,4 +1,6 @@ defmodule SkateWeb.AuthManager.Pipeline do + @moduledoc false + use Guardian.Plug.Pipeline, otp_app: :skate, error_handler: SkateWeb.AuthManager.ErrorHandler, diff --git a/lib/skate_web/channels/alerts_channel.ex b/lib/skate_web/channels/alerts_channel.ex index af39a70294..52e19e72de 100644 --- a/lib/skate_web/channels/alerts_channel.ex +++ b/lib/skate_web/channels/alerts_channel.ex @@ -1,4 +1,6 @@ defmodule SkateWeb.AlertsChannel do + @moduledoc false + use SkateWeb, :channel use SkateWeb.AuthenticatedChannel diff --git a/lib/skate_web/channels/channel_auth.ex b/lib/skate_web/channels/channel_auth.ex index 520d929452..0c59a67bc2 100644 --- a/lib/skate_web/channels/channel_auth.ex +++ b/lib/skate_web/channels/channel_auth.ex @@ -1,4 +1,6 @@ defmodule SkateWeb.ChannelAuth do + @moduledoc false + alias SkateWeb.AuthManager @doc """ diff --git a/lib/skate_web/channels/data_status_channel.ex b/lib/skate_web/channels/data_status_channel.ex index 55ff7aae6c..97c96a8d37 100644 --- a/lib/skate_web/channels/data_status_channel.ex +++ b/lib/skate_web/channels/data_status_channel.ex @@ -1,4 +1,6 @@ defmodule SkateWeb.DataStatusChannel do + @moduledoc false + use SkateWeb, :channel use SkateWeb.AuthenticatedChannel diff --git a/lib/skate_web/channels/notifications_channel.ex b/lib/skate_web/channels/notifications_channel.ex index c2e3a66101..f5bdd5fbb4 100644 --- a/lib/skate_web/channels/notifications_channel.ex +++ b/lib/skate_web/channels/notifications_channel.ex @@ -1,4 +1,6 @@ defmodule SkateWeb.NotificationsChannel do + @moduledoc false + use SkateWeb, :channel use SkateWeb.AuthenticatedChannel diff --git a/lib/skate_web/channels/train_vehicles_channel.ex b/lib/skate_web/channels/train_vehicles_channel.ex index d3f87620a2..3172de5235 100644 --- a/lib/skate_web/channels/train_vehicles_channel.ex +++ b/lib/skate_web/channels/train_vehicles_channel.ex @@ -1,4 +1,6 @@ defmodule SkateWeb.TrainVehiclesChannel do + @moduledoc false + use SkateWeb, :channel use SkateWeb.AuthenticatedChannel diff --git a/lib/skate_web/channels/vehicle_channel.ex b/lib/skate_web/channels/vehicle_channel.ex index 471b4265ac..b36e7df702 100644 --- a/lib/skate_web/channels/vehicle_channel.ex +++ b/lib/skate_web/channels/vehicle_channel.ex @@ -1,4 +1,6 @@ defmodule SkateWeb.VehicleChannel do + @moduledoc false + use SkateWeb, :channel use SkateWeb.AuthenticatedChannel diff --git a/lib/skate_web/channels/vehicles_channel.ex b/lib/skate_web/channels/vehicles_channel.ex index 98d26f7472..f0e11db5bb 100644 --- a/lib/skate_web/channels/vehicles_channel.ex +++ b/lib/skate_web/channels/vehicles_channel.ex @@ -1,4 +1,6 @@ defmodule SkateWeb.VehiclesChannel do + @moduledoc false + use SkateWeb, :channel use SkateWeb.AuthenticatedChannel require Logger diff --git a/lib/skate_web/channels/vehicles_search_channel.ex b/lib/skate_web/channels/vehicles_search_channel.ex index 957971c1e4..c2b35a205a 100644 --- a/lib/skate_web/channels/vehicles_search_channel.ex +++ b/lib/skate_web/channels/vehicles_search_channel.ex @@ -1,4 +1,6 @@ defmodule SkateWeb.VehiclesSearchChannel do + @moduledoc false + use SkateWeb, :channel use SkateWeb.AuthenticatedChannel require Logger diff --git a/lib/skate_web/ensure_admin_group.ex b/lib/skate_web/ensure_admin_group.ex index 6d8993beda..3124d38ee1 100644 --- a/lib/skate_web/ensure_admin_group.ex +++ b/lib/skate_web/ensure_admin_group.ex @@ -1,4 +1,6 @@ defmodule SkateWeb.EnsureAdminGroup do + @moduledoc false + import Plug.Conn def init(options), do: options diff --git a/lib/skate_web/ensure_environment_access.ex b/lib/skate_web/ensure_environment_access.ex index 322520a1e1..e55be966a4 100644 --- a/lib/skate_web/ensure_environment_access.ex +++ b/lib/skate_web/ensure_environment_access.ex @@ -1,4 +1,6 @@ defmodule SkateWeb.EnsureEnvironmentAccess do + @moduledoc false + import Plug.Conn def init(options), do: options diff --git a/lib/train_vehicles/parser.ex b/lib/train_vehicles/parser.ex index e472991cb8..125982bf7b 100644 --- a/lib/train_vehicles/parser.ex +++ b/lib/train_vehicles/parser.ex @@ -1,4 +1,6 @@ defmodule TrainVehicles.Parser do + @moduledoc false + alias TrainVehicles.TrainVehicle @spec parse(JsonApi.Item.t()) :: TrainVehicle.t() diff --git a/lib/train_vehicles/supervisor.ex b/lib/train_vehicles/supervisor.ex index d282d3eb39..5200afbabb 100644 --- a/lib/train_vehicles/supervisor.ex +++ b/lib/train_vehicles/supervisor.ex @@ -1,4 +1,6 @@ defmodule TrainVehicles.Supervisor do + @moduledoc false + use Supervisor @api_params [ diff --git a/lib/train_vehicles/train_vehicle.ex b/lib/train_vehicles/train_vehicle.ex index ee1cc92d90..76085f23a0 100644 --- a/lib/train_vehicles/train_vehicle.ex +++ b/lib/train_vehicles/train_vehicle.ex @@ -1,4 +1,6 @@ defmodule TrainVehicles.TrainVehicle do + @moduledoc false + @type id :: String.t() @type t :: %__MODULE__{ diff --git a/lib/util/time.ex b/lib/util/time.ex index 52b4207cea..ad38a38663 100644 --- a/lib/util/time.ex +++ b/lib/util/time.ex @@ -1,4 +1,6 @@ defmodule Util.Time do + @moduledoc false + @typedoc """ Seconds after midnight. This is used as a date-agnostic way to talk about time of day. diff --git a/test/support/factory.ex b/test/support/factory.ex index 43fe250314..f2d04b0994 100644 --- a/test/support/factory.ex +++ b/test/support/factory.ex @@ -1,4 +1,6 @@ defmodule Skate.Factory do + @moduledoc false + use ExMachina.Ecto, repo: Skate.Repo def operator_id_factory(_) do