Problem
For a package published to Hex with ex_doc configured, the documentation surface is empty:
@moduledoc "Documentation for Castle." in lib/castle.ex is the mix new placeholder.- None of the public functions (
make_releases/0, generate/1, unpack/1, install/1, commit/1, remove/1, releases/0) carry @doc or @spec.
Impact
The generated HexDocs page (README is main, but the module reference is still published) shows undocumented, un-spec'd functions. No Dialyzer coverage of the public contracts.
Suggested fix
- Replace the placeholder
@moduledoc with a real description of the runtime API.
- Add
@doc and @spec to the public functions. Several are intended only as release-command entry points rather than a general API — mark those @doc false (or document the distinction) so the published docs reflect actual intended usage.
Problem
For a package published to Hex with
ex_docconfigured, the documentation surface is empty:@moduledoc "Documentation forCastle."inlib/castle.exis themix newplaceholder.make_releases/0,generate/1,unpack/1,install/1,commit/1,remove/1,releases/0) carry@docor@spec.Impact
The generated HexDocs page (README is
main, but the module reference is still published) shows undocumented, un-spec'd functions. No Dialyzer coverage of the public contracts.Suggested fix
@moduledocwith a real description of the runtime API.@docand@specto the public functions. Several are intended only as release-command entry points rather than a general API — mark those@doc false(or document the distinction) so the published docs reflect actual intended usage.