Credence.Pattern.NoDocFalseOnPrivate
(credence v0.4.3)
Copy Markdown
Style rule: Detects @doc false placed before private functions (defp).
Private functions cannot have documentation — the compiler ignores @doc
on defp entirely. Adding @doc false is redundant noise that misleads
readers into thinking it's suppressing something.
Bad
@doc false
defp helper(x), do: x + 1Good
defp helper(x), do: x + 1
# If you want to hide a public function from docs:
@doc false
def internal_api(x), do: x + 1