v1.0.0#162
Draft
msz wants to merge 3 commits into
Draft
Conversation
The multi-behaviour example opened its code block with three backticks but closed it with four, so ex_doc treated the block as unclosed and warned when building docs. The warning only surfaced now because docs are not built in mix ci and the recent ex_doc 0.29 -> 0.40 bump tightened the check. Match the closing fence to three backticks.
Start a CHANGELOG.md at v1.0.0, following the narrative style of the GitHub releases (prose grouped by change type, PR links and contributor credit) rather than Keep a Changelog. Links are written as full URLs so they stay clickable when the file is rendered on HexDocs, where GitHub's #number and @handle autolinking does not apply. Wire it into the ex_doc extras and include it in the hex package files so it ships and renders on HexDocs.
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.
Cuts the 1.0.0 release: bumps the version in mix.exs and the README install snippet, and adds a CHANGELOG.md started at this version that follows the style of the GitHub releases and is wired into the HexDocs. Also folds in a separate fix for a long-standing unclosed doc code fence in Hammox.Protect that ex_doc only started warning about after the recent upgrade.