From 854d038145d23f48e546a22457c4f269ce6bae28 Mon Sep 17 00:00:00 2001
From: Anthony Shull <shull.anthony@gmail.com>
Date: Wed, 8 May 2024 12:18:17 -0500
Subject: [PATCH] missing docs

---
 lib/req/telemetry.ex | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/lib/req/telemetry.ex b/lib/req/telemetry.ex
index 9bae902aed..b18a2fa2bf 100644
--- a/lib/req/telemetry.ex
+++ b/lib/req/telemetry.ex
@@ -1,15 +1,23 @@
 defmodule Req.Telemetry do
   @moduledoc """
+  This Supervisor is responsible for starting the Telemetry poller and defining the metrics to be collected for Req (finch).
+  We poll the metrics every 60 seconds and send them to the `TelemetryMetricsSplunk` reporter.
   """
 
   use Supervisor
 
   alias Telemetry.Metrics
 
+  @doc """
+  Starts the supervisor.
+  """
   def start_link(arg) do
     Supervisor.start_link(__MODULE__, arg, name: __MODULE__)
   end
 
+  @doc """
+  Initializes the supervisor.
+  """
   def init(_arg) do
     telemetry_metrics_splunk_config = Application.get_env(:dotcom, :telemetry_metrics_splunk)