Skip to content

Commit

Permalink
Add minimal module doc
Browse files Browse the repository at this point in the history
  • Loading branch information
dersmon committed Aug 1, 2024
1 parent e5d777c commit b44c9bf
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions publication/lib/field_publication/publications/data.ex
Original file line number Diff line number Diff line change
@@ -1,4 +1,13 @@
defmodule FieldPublication.Publications.Data do
@moduledoc """
This module handles access to a publication's research database.
You can retrieve the raw documents or an extended version with the publication's configuration applied. The
latter will group the data fields and add translated labels for the different value types, relations etc. (if
there are any defined in the configuration). The extended version will be returned as a standardized struct,
see the `Document` struct definition below.
"""

require FieldPublicationWeb.Gettext

alias FieldPublication.{
Expand Down

0 comments on commit b44c9bf

Please sign in to comment.