Packages

tidy

0.0.5
0.1.9 0.1.8 0.1.7 0.1.6 0.1.5 0.1.4 0.1.3 0.1.2 0.1.1 0.1.0 0.0.6 0.0.5 0.0.4 0.0.3 0.0.2 0.0.1

Checks documentation and specs of Elixir modules.

HexDocs

Current section

Files

Jump to
Readme
16 Versions
0 Dependencies
Dependants
Files
Activity
tidy lib tidy checks module_doc.ex
Raw

lib/tidy/checks/module_doc.ex 

defmodule Tidy.Checks.ModuleDoc do

  @moduledoc ~S"""

  """

  alias Tidy.Module

  @behaviour Tidy.Check

  @defaults [

    level: :error

  ]



  @impl Tidy.Check

  def scope, do: :module



  @impl Tidy.Check

  def category, do: :doc



  @impl Tidy.Check

  def default_options, do: @defaults



  @impl Tidy.Check

  def check(%Module{doc: nil}, _opts), do: {:error, "Missing module doc.", "Missing module doc."}

  def check(%Module{doc: _}, _opts), do: :ok

end