From 7b96b703800d50bf37ba754d8c55dec28336101e Mon Sep 17 00:00:00 2001 From: laughingman7743 Date: Wed, 11 Nov 2026 21:46:50 +0900 Subject: [PATCH 1/4] Update rumdl to 0.3.3 and drop the MyST target workarounds rumdl 0.3.3 treats MyST `(label)=` targets as structural lines (rvben/rumdl#983), so MD044 and MD041 no longer check them as text. Remove the three MD044 disable comments on labels and enable MD041, which was off only because docs/*.md start with a target. Co-Authored-By: Claude Opus 5.5 --- .mise.toml | 2 +- .rumdl.toml | 7 +------ docs/index.md | 1 - docs/polars.md | 1 - docs/sqlalchemy.md | 1 - 5 files changed, 2 insertions(+), 10 deletions(-) diff --git a/.mise.toml b/.mise.toml index 13a387b24..6bf9d9a0f 100644 --- a/.mise.toml +++ b/.mise.toml @@ -10,4 +10,4 @@ python = "3.12" just = "latest" shellcheck = "0.11.0" actionlint = "1.7.12" -rumdl = "0.3.2" +rumdl = "0.3.3" diff --git a/.rumdl.toml b/.rumdl.toml index fea6c52a1..4c30b242b 100644 --- a/.rumdl.toml +++ b/.rumdl.toml @@ -25,14 +25,12 @@ enable = [ "MD012", "MD018", "MD019", "MD020", "MD021", "MD022", "MD023", "MD024", "MD025", "MD026", "MD027", "MD028", "MD029", "MD030", "MD031", "MD032", "MD033", "MD034", "MD035", "MD036", "MD037", "MD038", "MD039", "MD040", - "MD042", "MD044", "MD045", "MD046", "MD047", "MD048", "MD049", + "MD041", "MD042", "MD044", "MD045", "MD046", "MD047", "MD048", "MD049", "MD050", "MD051", "MD052", "MD053", "MD054", "MD055", "MD056", "MD058", "MD059", # Not enabled: # MD013: docs have long URLs and code lines that would be awkward to wrap # MD014: `$ command` style is intentional in docs/testing.md and README shell snippets - # MD041: MyST `(label)=` ref targets must come before the first heading, so the - # first line of many docs/*.md files is not an H1 # MD043: the docs share no single heading structure to require ] @@ -84,9 +82,6 @@ ignore = ["x"] ignored-definitions = ["//"] # Spell project and library names consistently in prose; code is exempt. -# rumdl also checks MyST `(label)=` targets, so the labels that contain one of -# these names disable MD044 for their line; remove those comments once the -# pinned rumdl skips targets (https://github.com/rvben/rumdl/issues/983). [MD044] names = ["PyAthena", "Athena", "SQLAlchemy", "fsspec", "Polars", "PyArrow", "pandas"] code-blocks = false diff --git a/docs/index.md b/docs/index.md index 46bb58632..a893a6ad4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -7,7 +7,6 @@ See LICENSE or https://opensource.org/licenses/MIT. SPDX-License-Identifier: MIT --> - (pyathena)= ![PyAthena](_static/header.png) diff --git a/docs/polars.md b/docs/polars.md index 8ac4a962f..30400fc60 100644 --- a/docs/polars.md +++ b/docs/polars.md @@ -1,4 +1,3 @@ - (polars)= # Polars diff --git a/docs/sqlalchemy.md b/docs/sqlalchemy.md index b09539ee0..5a6cf8b78 100644 --- a/docs/sqlalchemy.md +++ b/docs/sqlalchemy.md @@ -1,4 +1,3 @@ - (sqlalchemy)= # SQLAlchemy From dd79c0f9eedac6a16e2ba6d914c721c83bb7de27 Mon Sep 17 00:00:00 2001 From: laughingman7743 Date: Wed, 11 Nov 2026 21:56:06 +0900 Subject: [PATCH 2/4] Match markdownlint's MD041 front matter title matching markdownlint 0.38 matches the title key case-insensitively, while rumdl's default lookup is case-sensitive. Record that rumdl always allows Markdown images and badges before the first heading. Co-Authored-By: Claude Opus 5.5 --- .rumdl.toml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.rumdl.toml b/.rumdl.toml index 4c30b242b..bd0d113e1 100644 --- a/.rumdl.toml +++ b/.rumdl.toml @@ -72,6 +72,12 @@ list-items = true [MD036] punctuation = ".,;:!?。，；：！？" +# markdownlint matches a front matter title key case-insensitively. Unlike +# markdownlint, rumdl always lets Markdown images and badges precede the +# first heading; it has no option to disallow them. +[MD041] +front-matter-title-pattern = '(?i)^\s*"?title"?\s*[:=]' + [MD051] ignore-case = false From dffac0d665cc4c0760374d3a70e3d85a2a831016 Mon Sep 17 00:00:00 2001 From: laughingman7743 Date: Wed, 11 Nov 2026 22:05:23 +0900 Subject: [PATCH 3/4] Narrow the MD041 preamble note to inline images and badges Reference-style images and badges are still reported by rumdl. Co-Authored-By: Claude Opus 5.5 --- .rumdl.toml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.rumdl.toml b/.rumdl.toml index bd0d113e1..3b4f5ae8c 100644 --- a/.rumdl.toml +++ b/.rumdl.toml @@ -73,8 +73,8 @@ list-items = true punctuation = ".,;:!?。，；：！？" # markdownlint matches a front matter title key case-insensitively. Unlike -# markdownlint, rumdl always lets Markdown images and badges precede the -# first heading; it has no option to disallow them. +# markdownlint, rumdl always lets lines of only inline images or inline-linked +# badges precede the first heading; it has no option to disallow them. [MD041] front-matter-title-pattern = '(?i)^\s*"?title"?\s*[:=]' From 5b33d7190e6be0ba3bbd802adf48714be52851ad Mon Sep 17 00:00:00 2001 From: laughingman7743 Date: Wed, 11 Nov 2026 22:08:19 +0900 Subject: [PATCH 4/4] Do not overstate the MD041 preamble note rumdl still reports some inline images, such as one whose URL has parentheses. Co-Authored-By: Claude Opus 5.5 --- .rumdl.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.rumdl.toml b/.rumdl.toml index 3b4f5ae8c..2c756d059 100644 --- a/.rumdl.toml +++ b/.rumdl.toml @@ -73,7 +73,7 @@ list-items = true punctuation = ".,;:!?。，；：！？" # markdownlint matches a front matter title key case-insensitively. Unlike -# markdownlint, rumdl always lets lines of only inline images or inline-linked +# markdownlint, rumdl can let lines of only inline images or inline-linked # badges precede the first heading; it has no option to disallow them. [MD041] front-matter-title-pattern = '(?i)^\s*"?title"?\s*[:=]'