From abe559c41b182cafd34bab9a88950bc233d83d2e Mon Sep 17 00:00:00 2001 From: Kieran Eglin Date: Tue, 12 Mar 2024 09:54:08 -0700 Subject: [PATCH] [WIP] Added moduledocs --- lib/pinchflat/downloading/downloading_helpers.ex | 6 ++++++ lib/pinchflat/fast_indexing/fast_indexing_helpers.ex | 6 ++++++ lib/pinchflat/slow_indexing/slow_indexing_helpers.ex | 6 ++++++ 3 files changed, 18 insertions(+) diff --git a/lib/pinchflat/downloading/downloading_helpers.ex b/lib/pinchflat/downloading/downloading_helpers.ex index 7ac1da0..9217548 100644 --- a/lib/pinchflat/downloading/downloading_helpers.ex +++ b/lib/pinchflat/downloading/downloading_helpers.ex @@ -1,4 +1,10 @@ defmodule Pinchflat.Downloading.DownloadingHelpers do + @moduledoc """ + Methods for helping download media + + Many of these methods are made to be kickoff or be consumed by workers. + """ + require Logger alias Pinchflat.Media diff --git a/lib/pinchflat/fast_indexing/fast_indexing_helpers.ex b/lib/pinchflat/fast_indexing/fast_indexing_helpers.ex index 14f999e..6355df7 100644 --- a/lib/pinchflat/fast_indexing/fast_indexing_helpers.ex +++ b/lib/pinchflat/fast_indexing/fast_indexing_helpers.ex @@ -1,4 +1,10 @@ defmodule Pinchflat.FastIndexing.FastIndexingHelpers do + @moduledoc """ + Methods for performing fast indexing tasks and managing the fast indexing process. + + Many of these methods are made to be kickoff or be consumed by workers. + """ + alias Pinchflat.Media alias Pinchflat.Tasks alias Pinchflat.Sources.Source diff --git a/lib/pinchflat/slow_indexing/slow_indexing_helpers.ex b/lib/pinchflat/slow_indexing/slow_indexing_helpers.ex index d9d50a2..81e7784 100644 --- a/lib/pinchflat/slow_indexing/slow_indexing_helpers.ex +++ b/lib/pinchflat/slow_indexing/slow_indexing_helpers.ex @@ -1,4 +1,10 @@ defmodule Pinchflat.SlowIndexing.SlowIndexingHelpers do + @moduledoc """ + Methods for performing slow indexing tasks and managing the indexing process. + + Many of these methods are made to be kickoff or be consumed by workers. + """ + require Logger alias Pinchflat.Media