KogenCredo.Check.Warning.NoCredoDisable (KogenCredo v0.1.0)

View Source

Basics

This check is disabled by default.

Learn how to enable it via .credo.exs.

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

Explanation

# credo:disable-for-... hides a finding instead of fixing it. Fix the code, or change the check configuration in a reviewed place. Note: this check is advisory and can itself be suppressed or disabled, see the module documentation.

Check-Specific Parameters

Use the following parameters to configure this check:

:allowed_directives

Directive names allowed (e.g. disable-for-next-line).

This parameter defaults to [].

:allowed_checks

Check names whose suppression is allowed.

This parameter defaults to [].

General Parameters

Like with all checks, general params can be applied.

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