Repository navigation
Fix edoc failure that broke the 0.16.0 release, build docs in CI - #203
Merged
Merged
Conversation
edoc reads the plain comment before a type as its documentation, and <<"1XX">> in it is invalid markup, which broke rebar3 hex publish. Build the docs in CI so this shows up before a release. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
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.
make releasefailed inrebar3 hex publish:edoc treats a plain
%%comment just above a-typeas that type's documentation and parses it as markup. The comment onhttp_status_code(), added in #200, contained<<"1XX">>, which is not valid markup. The comment now reads"1XX" to "5XX".CI never built the docs, so nothing caught this before the release. A new Build docs step runs
make doc, which uses ex_doc on top of edoc chunks and fails on the old comment.I checked locally that
make docfails on main and passes here, and thatrebar3 hex buildpasses here.🤖 Generated with Claude Code