Credo.Check.Design.TagFIXME (Credo v1.7.12)

View Source

Basics

This check is enabled by default.

Learn how to disable it via .credo.exs.

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

Explanation

FIXME comments are used to indicate places where source code needs fixing.

Example:

# FIXME: this does no longer work, research new API url
defp fun do
  # ...
end

The premise here is that FIXME should indeed be fixed as soon as possible and are therefore reported by Credo.

Like all Software Design issues, this is just advice and might not be applicable to your project/situation.

Check-Specific Parameters

Use the following parameters to configure this check:

:include_doc

Set to true to also include tags from @doc attributes.

This parameter defaults to true.

General Parameters

Like with all checks, general params can be applied.

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