Fix Credo, add moduledocs to all new modules

beam-community · May 22, 2020 · 28061f8 · 28061f8
1 parent 621b06e
commit 28061f8
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
diff --git a/lib/companies_web/historical_data.ex b/lib/companies_web/historical_data.ex
@@ -1,4 +1,11 @@
 defmodule CompaniesWeb.HistoricalData do
+  @moduledoc """
+  Single source of truth to gather all individual modules that provide historical
+  data to live dashboard and merge their seperate history maps into one. If adding
+  a new source of metric history for LiveDashboard, it only needs to implement
+  it's own signatures/0 method as the other modules here do, and be added the the
+  list of signatures below.
+  """
   alias CompaniesWeb.{RepoMetricsHistory, ViewingStats}
 
   def signatures do

diff --git a/lib/companies_web/repo_metrics_history.ex b/lib/companies_web/repo_metrics_history.ex
@@ -1,4 +1,9 @@
 defmodule CompaniesWeb.RepoMetricsHistory do
+  @moduledoc """
+  GenServer to handle historical data for Ecto queries and rebroadcast to
+  LiveDashboard under seperate history-focused telemetry namespace.
+  """
+
   use GenServer
 
   @telemetry_event [:companies, :repo, :query]

diff --git a/lib/companies_web/viewing_stats.ex b/lib/companies_web/viewing_stats.ex
@@ -1,4 +1,9 @@
 defmodule CompaniesWeb.ViewingStats do
+  @moduledoc """
+  GenServer to handle aggregating simple app stats and history for telemetry_poller
+  to pass on to LiveDashboard.
+  """
+
   use GenServer
 
   @telemetry_event [:page_views, :count_events]