ExDoc inserting child_spec/1 into generated docs. How to suppress?

Yes! The @doc ... written immediately before the use GenServer will be attached to the child_spec/1 function that is generated. (source: the ‘how to supervise’ section of the GenServer module docs)

If you add @doc false then ExDoc won’t document a function (and won’t list it). So if you add @doc false immediately before the use GenServer line, the documentation for child_spec will be suppressed.

EDIT: However, if you do this, it might be worthwhile to at the very least document in the module docs that this is a GenServer module that can be started under a supervisor in the normal way.

Nice! Thanks.

Another way to do it, that may be more obvious, is to override the function and mark it:

@doc false
def child_spec(opts), do: super(opts)

As the function is generated, you actually have that function in the compiled module. Why not keep the docs then?

Just my judgement call. I suspect my initial audience won’t be interested in that.