6 Commits
Author SHA1 Message Date
aweiker d3adeaac25 fix: standardize cross-reference link text for Pattern 10 subsection 2026-05-02 10:13:56 -07:00
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
aweiker 10218813d3 docs: backfill TOC + decision trees, fix review findings
- Add ## Contents and ## Decision Tree to all 10 existing pattern files
- Fix embed_as/1 semantics inversion in types.md (:self → :dump)
- Fix fabricated __meta__.changes reference in changesets.md
- Fix default primary key type (:integer → :id) in schemas.md
- Combine @impl subsections into single "Minimal Callback Annotation"
2026-05-01 22:13:35 -07:00
aweiker b33accf37c docs: extend @impl pattern with multi-clause and @spec guidance 2026-05-01 21:29:47 -07:00
aweiker 49a006dd18 docs: add table of contents to all Ecto pattern files 2026-05-01 20:55:15 -07:00
aweiker d28b9c8844 fix: use Repo.transaction instead of non-existent Repo.transact 2026-05-01 20:41:06 -07:00