Packages

tidy

0.0.4
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 check.ex
Raw

lib/tidy/check.ex 

defmodule Tidy.Check do

  @type category :: :doc | :spec

  @type scope :: :module | :functions



  @callback scope :: scope

  @callback category :: category

  @callback default_options :: Keyword.t()

  @callback check(Tidy.Module.t() | Tidy.Function.t(), Keyword.t()) ::

              :ok | {:error, String.t(), String.t()}

end