Doc links comment - #236
Merged
Merged
Conversation
Rewords the comment beside the doc_links stage in .quality.exs so it names what the stage checks: a relative link in a Markdown extra to a file that is not itself an extra. Links in moduledocs are the Docs stage's, and the comment now says so. No stage or option changes.
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
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.
What changed
The comment beside the
doc_linksstage in.quality.exssaid the stage fails on "a published relative link to a file that is not an extra". The stage reads only relative links in Markdown extras (and the README, for the package-files rule), so a relative link in a moduledoc is not its concern. The comment now says "a relative link in a Markdown extra to a file that is not itself an extra (moduledoc links are the Docs stage's)". Only comment lines changed; the stage and its options are as they were.CHANGELOG.mdhas nochangelog.d/link, so there is nothing to align there.Review
Checked against ex_quality's
ExQuality.Stages.DocLinks(0.15.1, the version the lockfile pins): itsnot_an_extrarule is "a relative link in a Markdown extra whose target is not itself an extra", its moduledoc says links in moduledocs and function docs are the Docs stage's (ExQuality.Stages.Docs), and the other three clauses of the comment match itsreadme_not_packaged,duplicate_extraandrewritten_to_other_extrarules. The diff touches comment lines only;.quality.exsstill parses. The file is outside the gate's build paths, so no gate run applies (docs-only commit row). Review tier: gate (config comment words, no code).