[WIP] Added moduledocs

This commit is contained in:
Kieran Eglin 2024-03-12 09:54:08 -07:00
parent a202652c00
commit abe559c41b
No known key found for this signature in database
GPG key ID: 193984967FCF432D
3 changed files with 18 additions and 0 deletions

View file

@ -1,4 +1,10 @@
defmodule Pinchflat.Downloading.DownloadingHelpers do 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 require Logger
alias Pinchflat.Media alias Pinchflat.Media

View file

@ -1,4 +1,10 @@
defmodule Pinchflat.FastIndexing.FastIndexingHelpers do 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.Media
alias Pinchflat.Tasks alias Pinchflat.Tasks
alias Pinchflat.Sources.Source alias Pinchflat.Sources.Source

View file

@ -1,4 +1,10 @@
defmodule Pinchflat.SlowIndexing.SlowIndexingHelpers do 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 require Logger
alias Pinchflat.Media alias Pinchflat.Media