AshCredo.Check.Readability.ActionMissingDescription (ash_credo v0.5.2)

Copy Markdown 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

Actions without a description produce less useful API documentation in AshGraphql and AshJsonApi. Add a description:

create :register do
  description "Register a new user account."
  # ...
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.