From 911ca9800b1d3d3e012b15b586a05ee129439d1d Mon Sep 17 00:00:00 2001
From: Simon Hohl <simon.hohl@dainst.de>
Date: Tue, 6 Aug 2024 10:55:19 +0200
Subject: [PATCH] Add basic module doc string

---
 publication/lib/field_publication_web/user_auth.ex | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/publication/lib/field_publication_web/user_auth.ex b/publication/lib/field_publication_web/user_auth.ex
index 9fc83e762d..cb1e0f3530 100644
--- a/publication/lib/field_publication_web/user_auth.ex
+++ b/publication/lib/field_publication_web/user_auth.ex
@@ -9,6 +9,12 @@ defmodule FieldPublicationWeb.UserAuth do
   import Plug.Conn
   import Phoenix.Controller
 
+  @moduledoc """
+  This module implements plugs for handling user authentication and the different authorization levels.
+
+  See also the official [Phoenix documentation](https://hexdocs.pm/phoenix/plug.html).
+  """
+
   defmodule Token do
     @enforce_keys [:name, :token, :context]
     defstruct [:name, :token, :context]