From 1bbd17621b3e633e16614197bc0baac06fe8f8fe Mon Sep 17 00:00:00 2001 From: JohnnyT Date: Sat, 26 Sep 2026 07:35:49 -0600 Subject: [PATCH] Doc links comment 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. --- .quality.exs | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/.quality.exs b/.quality.exs index 0589e63..ca9d36b 100644 --- a/.quality.exs +++ b/.quality.exs @@ -59,10 +59,11 @@ # that this gate is the pre-publish check for the package's docs, locally # and in CI. The Docs stage fails on any ExDoc warning. The Doc links stage # fails on the link rules ExDoc accepts silently: a README relative link to - # a file not in the package files, a published relative link to a file that - # is not an extra, two extras sharing a basename, and a silent rewrite to a - # different extra. Each of those builds cleanly and breaks on HexDocs or - # hex.pm, so only a gate stage catches them before a publish. + # a file not in the package files, a relative link in a Markdown extra to a + # file that is not itself an extra (moduledoc links are the Docs stage's), + # two extras sharing a basename, and a silent rewrite to a different extra. + # Each of those builds cleanly and breaks on HexDocs or hex.pm, so only a + # gate stage catches them before a publish. docs: [ enabled: :auto ],