docs: add @moduledoc to UserAuth and UserNotifier
Resolves credo readability warnings for missing module documentation.
This commit is contained in:
parent
0513154b01
commit
0a7ad6af8a
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user