From 0a7ad6af8aa9992215a73143d42b0d5ca1e351b4 Mon Sep 17 00:00:00 2001 From: Willem van den Ende Date: Tue, 5 May 2026 22:13:54 +0100 Subject: [PATCH] docs: add @moduledoc to UserAuth and UserNotifier Resolves credo readability warnings for missing module documentation. --- app/lib/firehose/accounts/user_notifier.ex | 7 +++++++ app/lib/firehose_web/user_auth.ex | 8 ++++++++ 2 files changed, 15 insertions(+) diff --git a/app/lib/firehose/accounts/user_notifier.ex b/app/lib/firehose/accounts/user_notifier.ex index c6d2c59..4cc4a7c 100644 --- a/app/lib/firehose/accounts/user_notifier.ex +++ b/app/lib/firehose/accounts/user_notifier.ex @@ -1,4 +1,11 @@ defmodule Firehose.Accounts.UserNotifier do + @moduledoc """ + Sends notification emails to users. + + Handles delivery of login instructions (magic link or confirmation), + email update instructions, and other account-related notifications. + """ + import Swoosh.Email alias Firehose.Mailer diff --git a/app/lib/firehose_web/user_auth.ex b/app/lib/firehose_web/user_auth.ex index 96bdfb4..b53f91b 100644 --- a/app/lib/firehose_web/user_auth.ex +++ b/app/lib/firehose_web/user_auth.ex @@ -1,4 +1,12 @@ defmodule FirehoseWeb.UserAuth do + @moduledoc """ + Handles user authentication for the web layer. + + Provides plugs and callbacks for logging users in and out, + managing session tokens, enforcing authentication requirements, + and integrating with LiveView via `on_mount` callbacks. + """ + use FirehoseWeb, :verified_routes import Plug.Conn