Basics
This check is disabled by default.
Learn how to enable it via .credo.exs.
This check has a base priority of high and works with any version of Elixir.
Explanation
Do not add comments or documentation attributes to files targeted by this check.
By default, it targets Ecto migration files, which should be concise,
executable records of schema and data changes. Configure paths to enforce
the same policy in other directories or files. Document the rationale for a
migration, field type, or operational constraint in the pull request, issue,
ADR, or deployment documentation instead.
For an exceptional targeted file, disable this check for that file with:
# credo:disable-for-this-file LexCredo.Check.Warning.NoCommentsCheck-Specific Parameters
Use the following parameters to configure this check:
:exclude_test_files
When true, skips test files. Default: false. This normally has no effect because Ecto migrations are not test files.
This parameter defaults to false.
:paths
Files to inspect. Each entry may be an exact relative file path, a relative directory path, or a regular expression. Defaults to conventional Ecto migration directories (priv/*/migrations/).
This parameter defaults to [~r/(?:^|\/)priv\/[^\/]+\/migrations(?:\/|$)/].
General Parameters
Like with all checks, general params can be applied.
Parameters can be configured via the .credo.exs config file.