Repository navigation
Point the MD044 label suppressions to the upstream rumdl issue - #1376
Conversation
Under the MyST flavor, rumdl 0.3.2 checks MyST targets as text, so the labels that contain a configured name need a disable comment. Link the upstream report so that the comments can be removed once a fixed rumdl is pinned. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
| # rumdl also checks MyST `(label)=` targets, so the labels that contain one of | ||
| # these names disable MD044 for their line. | ||
| # these names disable MD044 for their line; remove those comments once the | ||
| # pinned rumdl skips targets (https://github.com/rvben/rumdl/issues/983). |
There was a problem hiding this comment.
Self-review round one (implementation behavior)
- Base:
29cc1d3d43f3f0dd108e44ec59f080edd7747ece - Head:
3aebdae9a05c32e70f1d18c473d60518542d592d - Covered: the only changed file,
.rumdl.toml(comment lines 87-89).
Result: CLEAN
- Comment-only TOML change;
rumdl check .still reads the configuration and reports no issues in 30 files, andjust lintpasses. - "those comments" refers to the
rumdl-disable-next-line MD044comments named in the previous line; they exist atdocs/index.md:10,docs/polars.md:1anddocs/sqlalchemy.md:1on the base.
| # rumdl also checks MyST `(label)=` targets, so the labels that contain one of | ||
| # these names disable MD044 for their line. | ||
| # these names disable MD044 for their line; remove those comments once the | ||
| # pinned rumdl skips targets (https://github.com/rvben/rumdl/issues/983). |
There was a problem hiding this comment.
Self-review round two (claims)
- Base:
29cc1d3d43f3f0dd108e44ec59f080edd7747ece - Head:
3aebdae9a05c32e70f1d18c473d60518542d592d - Covered: the
.rumdl.tomlcomment, the PR body, and the commit message.
Result: CLEAN
- "rumdl 0.3.2 checks MyST targets as text":
.mise.toml:13pinsrumdl = "0.3.2".rumdl check --no-config --flavor myst -c 'MD044.names = ["Sphinx"]'reports(sphinx)=under MD044 and MD041, andrumdl fmtrewrites it to(Sphinx)=. - The link points to MyST flavor: targets (
(label)=) are checked as text (MD044, MD041) rvben/rumdl#983, which is open and describes this behavior. - The comment says only to remove the suppressions once the pinned rumdl skips targets, and does not say when that will happen.
| # 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. | ||
| # these names disable MD044 for their line; remove those comments once the |
There was a problem hiding this comment.
Independent review (relayed result; static review)
- Reviewer: Codex CLI 0.166.0 (
codex exec --sandbox read-only), modelgpt-6-astra, session01a1b48b-1aa5-7df2-8d75-41d2371267f6 - Base:
29cc1d3d43f3f0dd108e44ec59f080edd7747ece - Head:
3aebdae9a05c32e70f1d18c473d60518542d592d - Package: a detached snapshot of the head, the literal diff, and a neutral description of the upstream issue. The prompt left out the PR number, PR body, commit message and self-review findings.
- Constraints: read-only; no edits, builds, tests, commits, pushes or GitHub access. Read-only
rumdlchecks were allowed. - After the review, the snapshot was still clean and at the head.
Result: CLEAN
Reviewer output:
Covered: the specified diff and HEAD, rumdl 0.3.2 pin/runtime, MyST and MD044 configuration, Sphinx/lint wiring, and all three suppressions in docs/index.md, docs/polars.md, and docs/sqlalchemy.md.
CLEAN
The comment accurately explains the workaround and gives an actionable removal condition: the repository’s pinned rumdl must skip MyST targets. All three files pass rumdl; omitting their suppressions from piped input reproduces the expected MD044 violations.
Read-only inspection and lint checks only; no files changed, builds, or tests. The upstream issue was assessed solely from your description.
WHAT
Extends the comment on
[MD044]in.rumdl.tomlwith a link to rvben/rumdl#983, and says to remove the<!-- rumdl-disable-next-line MD044 -->comments above the MyST targets indocs/index.md,docs/polars.mdanddocs/sqlalchemy.mdonce the pinned rumdl skips targets.WHY
Trivial follow-up to #1371 (GH-1368).
Under the MyST flavor, rumdl 0.3.2 checks MyST targets (
(label)=) as text, so MD044 reports the labels that contain a configured name, andrumdl fmtrewrites them.This was reported upstream as rvben/rumdl#983. The link records when the suppressions can go.
TEST
Tested commit: 3aebdae.
mise exec -- rumdl check .: no issues in 30 files.just lint: passed..rumdl.toml; no AWS tests are needed.🤖 Generated with Claude Code