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
Showing only changes of commit d3adeaac25 - Show all commits
+1 -1
View File
1
@@ -215,7 +215,7 @@ def chunk(list, size), do: ...
**Don't use this when:**
- The function is private (use `# comments` for private function notes)
- The function name + typespec are completely self-explanatory (e.g., `@spec pid() :: pid()`)
- You're implementing a behaviour callback — `@impl true` sets `@doc false` automatically. Override only when the implementation has semantics the behaviour can't speak to (see [Pattern 10](#when-to-override-doc-false-on-impl-functions))
- You're implementing a behaviour callback — `@impl true` sets `@doc false` automatically. Override only when the implementation has semantics the behaviour can't speak to (see [Pattern 10 — implementation-side docs](#when-to-override-doc-false-on-impl-functions))
**Over-application example:**
```elixir