View Source Credo.Check.Readability.ImplTrue (Credo v1.7.4)
Basics
This check is disabled by default.
Learn how to enable it via
.credo.exs
.
This check has a base priority of normal
and works with any version of Elixir.
Explanation
When implementing behaviour callbacks, @impl true
indicates that a function implements a callback, but
a better way is to note the actual behaviour being implemented, for example @impl MyBehaviour
. This
not only improves readability, but adds extra validation in cases where multiple behaviours are implemented
in a single module.
Instead of:
@impl true
def my_funcion() do
...
use:
@impl MyBehaviour
def my_funcion() do
...
Like all Readability
issues, this one is not a technical concern.
But you can improve the odds of others reading and liking your code by making
it easier to follow.
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.