Skip to content

Point the MD044 label suppressions to the upstream rumdl issue - #1376

Merged
laughingman7743 merged 1 commit into
masterfrom
chore/rumdl-983-pointer
Nov 7, 2026
Merged

laughingman7743 merged 1 commit into
masterfrom
chore/rumdl-983-pointer

Conversation

@laughingman7743

Copy link
Copy Markdown
Member

WHAT

Extends the comment on [MD044] in .rumdl.toml with a link to rvben/rumdl#983, and says to remove the <!-- rumdl-disable-next-line MD044 --> comments above the MyST targets in docs/index.md, docs/polars.md and docs/sqlalchemy.md once 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, and rumdl fmt rewrites 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.
  • Comment-only change to .rumdl.toml; no AWS tests are needed.

🤖 Generated with Claude Code

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>
Comment thread .rumdl.toml
# 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).

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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, and just lint passes.
  • "those comments" refers to the rumdl-disable-next-line MD044 comments named in the previous line; they exist at docs/index.md:10, docs/polars.md:1 and docs/sqlalchemy.md:1 on the base.

Comment thread .rumdl.toml
# 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).

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Self-review round two (claims)

  • Base: 29cc1d3d43f3f0dd108e44ec59f080edd7747ece
  • Head: 3aebdae9a05c32e70f1d18c473d60518542d592d
  • Covered: the .rumdl.toml comment, the PR body, and the commit message.

Result: CLEAN

  • "rumdl 0.3.2 checks MyST targets as text": .mise.toml:13 pins rumdl = "0.3.2". rumdl check --no-config --flavor myst -c 'MD044.names = ["Sphinx"]' reports (sphinx)= under MD044 and MD041, and rumdl fmt rewrites 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.

Comment thread .rumdl.toml
# 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

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Independent review (relayed result; static review)

  • Reviewer: Codex CLI 0.166.0 (codex exec --sandbox read-only), model gpt-6-astra, session 01a1b48b-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 rumdl checks 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.

@laughingman7743
laughingman7743 marked this pull request as ready for review November 7, 2026 05:51
@laughingman7743
laughingman7743 merged commit b66b045 into master Nov 7, 2026
13 checks passed
@laughingman7743
laughingman7743 deleted the chore/rumdl-983-pointer branch November 7, 2026 06:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant