docs: add rule for when @impl functions earn their own @doc #2

Merged
rodin merged 2 commits from docs/impl-doc-override-rule into master 2026-05-02 17:18:16 +00:00

2 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