Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
laughingman7743 merged 1 commit into from
Nov 7, 2026
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .rumdl.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,8 @@ 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.
# these names disable MD044 for their line; remove those comments once the

@laughingman7743 laughingman7743 Nov 7, 2026

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.

# pinned rumdl skips targets (https://github.com/rvben/rumdl/issues/983).

@laughingman7743 laughingman7743 Nov 7, 2026

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.

@laughingman7743 laughingman7743 Nov 7, 2026

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.

[MD044]
names = ["PyAthena", "Athena", "SQLAlchemy", "fsspec", "Polars", "PyArrow", "pandas"]
code-blocks = false
Expand Down
Loading