Skip to content

Fix inaccurate documentation, unresolvable references and typos - #228

Merged
hlindset merged 6 commits into
elixir-image:mainfrom
hlindset:fix/documentation-accuracy
Aug 5, 2026
Merged

Fix inaccurate documentation, unresolvable references and typos#228
hlindset merged 6 commits into
elixir-image:mainfrom
hlindset:fix/documentation-accuracy

Conversation

@hlindset

@hlindset hlindset commented Aug 5, 2026

Copy link
Copy Markdown
Collaborator

Corrections where the docs disagreed with the code: rejected option names, stale defaults, an invalid example, and impossible @doc since: versions. Then presentation fixes: references written in ways ex_doc can't resolve, so they rendered as literal text instead of links, plus typos and stray backticks on prose.

@hlindset
hlindset merged commit 2676df5 into elixir-image:main Aug 5, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant