From 4da24be698438ed58eae3c78fefd123151e972c4 Mon Sep 17 00:00:00 2001 From: JohnnyT Date: Sat, 26 Sep 2026 07:33:42 -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 | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.quality.exs b/.quality.exs index f8a4599..70f22f5 100644 --- a/.quality.exs +++ b/.quality.exs @@ -33,10 +33,10 @@ # The two docs stages make this gate the pre-publish check for the package's # docs. Docs runs `mix docs` and fails on any ExDoc warning. Doc links 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, a silent rewrite to a different - # extra. Both are opt-in in ex_quality; `:auto` runs them when :ex_doc is - # installed. + # 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, a silent rewrite to a different extra. Both are + # opt-in in ex_quality; `:auto` runs them when :ex_doc is installed. docs: [ enabled: :auto ],