Bylaw.Credo.Check.Elixir.DocBeforeSpec (bylaw_credo v0.1.0-alpha.1)

Basics

This check has a base priority of normal and works with any version of Elixir.

Explanation

Requires @doc to appear before @spec for public function definitions.

Examples

Avoid:

  @spec handle(result :: term()) :: :ok
  @doc "Handles the result."
  def handle(result), do: :ok

Prefer:

  @doc "Handles the result."
  @spec handle(result :: term()) :: :ok
  def handle(result), do: :ok

Notes

This check uses static AST analysis, so it favors clear source-level patterns over runtime behavior.

Options

This check has no check-specific options. Configure it with an empty option list.

Usage

Add this check to Credo's checks: list in .credo.exs:

%{
  configs: [
    %{
      name: "default",
      checks: [
        {Bylaw.Credo.Check.Elixir.DocBeforeSpec, []}
      ]
    }
  ]
}

Check-Specific Parameters

There are no specific parameters for this check.

General Parameters

Like with all checks, general params can be applied.

Parameters can be configured via the .credo.exs config file.