Update moduledocs

code-shoily · Oct 25, 2023 · f619787 · f619787
1 parent 88a6fe8
commit f619787
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 6 deletions.
diff --git a/lib/helpers/meta.ex b/lib/helpers/meta.ex
@@ -1,5 +1,5 @@
 defmodule AdventOfCode.Helpers.Meta do
-  @doc """
+  @moduledoc """
   Returns the info of the year. This returns the important links and info
   of all the days completed.
   """

diff --git a/lib/helpers/summarizer.ex b/lib/helpers/summarizer.ex
@@ -1,4 +1,8 @@
 defmodule AdventOfCode.Helpers.Summarizer do
+  @moduledoc"""
+  Collects summary information about the codebase such as number of stars, problems solved etc
+  """
+
   alias AdventOfCode.Helpers.Meta
 
   @year_range 2015..2022
@@ -21,7 +25,7 @@ defmodule AdventOfCode.Helpers.Summarizer do
 
     """
     #{trophy}
-    
+
     #{header}
     |:---:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
     #{content}
@@ -68,9 +72,9 @@ defmodule AdventOfCode.Helpers.Summarizer do
     """
     <!-- AUTOGENERATED -- DO NOT EDIT -- use `mix gen_stats` -->
     # Advent of Code #{year}
-    
+
     [Main Page](https://adventofcode.com/#{year}) | [Tests](/test/#{year})
-    
+
     #{links |> Enum.join(" | ")}
     """
   end
@@ -90,9 +94,9 @@ defmodule AdventOfCode.Helpers.Summarizer do
 
     """
     #{heading}
-    
+
     #{trophy}
-    
+
     #{table_header}
     | :---: | :------: | ---: | :---: | :---: |
     #{table_content}