Credo.Check.Readability.VariableNames (Credo v1.5.0) View Source

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

Explanation

Variable names are always written in snake_case in Elixir.

# snake_case:

incoming_result = handle_incoming_message(message)

# not snake_case

incomingResult = handle_incoming_message(message)

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.

Configuration parameters

There are no specific parameters for this check.

Like with all checks, general params can be applied.

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