OptimumCredo.Check.Readability.DocumentationFormatting (OptimumCredo v0.5.0)

Basics

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

Explanation

Function documentation should have proper spacing for readability.

Examples

Bad:

@doc """
Returns the index URL.

## Examples
iex> index_url()
"http://localhost:4000/index.md"
"""
def index_url do
  # ...
end

Good:

@doc """
Returns the index URL.

## Examples

iex> index_url()
"http://localhost:4000/index.md"
"""
def index_url do
  # ...
end

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.