docs: mix docs builds clean, zero warnings#12
Merged
joshrotenberg merged 1 commit intomainfrom Apr 18, 2026
Merged
Conversation
22 hexdocs warnings resolved: - 20 warnings from defdelegate auto-following into hidden GenAgentEnsemble.Server (@moduledoc false). Added @doc strings on every defdelegate in GenAgentEnsemble and GenAgentEnsemble.IEx so ex_doc uses the explicit docs instead of trying to pull from the hidden target. Public API now renders proper docs on hexdocs. - 2 references to a `GenAgentEnsemble.chat/1` that no longer exists (removed in the native-iex pivot). Rewrote the Echo backend moduledoc example to use ask/2 instead.
4 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
22
mix docswarnings → 0.20 of them: defdelegate auto-follow into hidden module
GenAgentEnsembleandGenAgentEnsemble.IExbothdefdelegateintoGenAgentEnsemble.Server, which has@moduledoc false. Ex_doc follows the target to render docs and warns that the target is hidden.Fix: add explicit
@docstrings on eachdefdelegate. Ex_doc uses those instead of following the target.Side benefit: the public API now has proper per-function docs on hexdocs rather than inheriting silence from
Server.2 of them: dead references to
GenAgentEnsemble.chat/1The
chat/1function was removed in the native-iex pivot (branchchat-replper memory notes). Two references lingered inBackends.Echo's moduledoc — rewrote the example to useask/2.Test plan
mix docs— 0 warnings (was 22)mix format --check-formattedcleanmix compile --warnings-as-errorscleanmix credo --strictcleanmix testgreen (86 tests)Closes #4