# Inch CI

Credo.Check.Readability.PredicateFunctionNames

Parsed documentation:

Predicate functions/macros should be named accordingly:

* For functions, they should end in a question mark.

    # okay

    defp user?(cookie) do
    end

    defp has_attachment?(mail) do
    end

    # not okay

    defp is_user?(cookie) do
    end

    defp is_user(cookie) do
    end

* For guard-safe macros they should have the prefix `is_` and not end in a question mark.

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.

No suggestions.

Please help! Open an issue on GitHub if this assessment is incorrect.

Inch CI evaluates your project's inline code documentation and reports grades for each class, module and method.

It is an open source project, created by René Föhring (@rrrene), based on Inch.

Please create an issue if anything seems broken or worthy of improvement.