aweiker edef02ed0f docs: add rule for when @impl functions earn their own @doc
Pattern 10 (Callback Documentation Convention) now owns the full rule
for callback documentation — both the behaviour side (@callback docs)
and the implementation side (when to override @doc false on @impl
functions). Patterns 2 and 5 cross-reference Pattern 10 instead of
making their own partial statements.

The test: "Would this statement be true of any implementation?" If yes,
it belongs on the @callback. If no, the implementation earns its own
@doc.
2026-05-02 10:03:56 -07:00
2026-04-30 11:58:35 +00:00

Elixir Patterns

Idiomatic Elixir patterns extracted from the Elixir source code with verified file:line citations.

Structure

  • patterns/ — Core patterns (GenServer, error handling, data transforms, processes, testing, docs, typespecs, macros, behaviours, modules)
  • smells/ — Anti-patterns and common mistakes the Elixir team avoids
  • changelog/ — Daily digest of merged Elixir PRs with discussion summaries

Philosophy

These rules are derived from what the Elixir source code actually does, not opinions or blog posts. Every pattern cites specific files and line numbers.

When unsure how to do something in Elixir, look at how Elixir core does it. This is how we define what "idiomatic" actually means.

S
Description
Idiomatic Elixir and Phoenix patterns extracted from source code with file path + line number citations
Readme MIT 359 KiB
Languages
Markdown 100%