diff --git a/lib/home73k/blog.ex b/lib/home73k/blog.ex index 649bc94..d533c43 100644 --- a/lib/home73k/blog.ex +++ b/lib/home73k/blog.ex @@ -1,4 +1,7 @@ defmodule Home73k.Blog do + @moduledoc """ + Blog content loading & data access functions. + """ import Home73k, only: [app_blog_content: 0] alias Home73k.Blog.Post diff --git a/lib/home73k/blog/post.ex b/lib/home73k/blog/post.ex index 6194883..cd324e6 100644 --- a/lib/home73k/blog/post.ex +++ b/lib/home73k/blog/post.ex @@ -1,4 +1,7 @@ defmodule Home73k.Blog.Post do + @moduledoc """ + Blog Post struct definition and content parsing functions. + """ alias Home73k.Highlighter @enforce_keys [:title, :id, :date, :author, :tags, :lede, :body, :corpus] @@ -76,7 +79,7 @@ defmodule Home73k.Blog.Post do # grab text only, rejecting HTML # downcase & scrub line breaks, slashes corpus = - (tags ++ [title, (lede && lede) || " ", body]) + (tags ++ [title, lede || " ", body]) |> Enum.join(" ") |> Floki.parse_fragment!() |> Floki.text() diff --git a/lib/home73k_web/live/blog_live.ex b/lib/home73k_web/live/blog_live.ex index b6e537c..b7906f3 100644 --- a/lib/home73k_web/live/blog_live.ex +++ b/lib/home73k_web/live/blog_live.ex @@ -1,4 +1,7 @@ defmodule Home73kWeb.BlogLive do + @moduledoc """ + LiveView engine for Blog navigation + """ use Home73kWeb, :live_view alias Home73k.Blog diff --git a/lib/home73k_web/live/live_helpers.ex b/lib/home73k_web/live/live_helpers.ex index 600bd81..ad1a519 100644 --- a/lib/home73k_web/live/live_helpers.ex +++ b/lib/home73k_web/live/live_helpers.ex @@ -1,4 +1,8 @@ defmodule Home73kWeb.LiveHelpers do + @moduledoc """ + Functions to make working with Phoenix LiveView a little easier. + """ + @doc """ Performs the {:noreply, socket} for a given socket. This helps make the noreply pipeable