Repository navigation
Close configuration gaps left by the rumdl migration (GH-1368) #1371
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.
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,6 +16,7 @@ include = [ | |
| "scripts/**/*.md", | ||
| "cloudformation/**/*.md", | ||
| "/*.md", | ||
| ".agents/skills/**/*.md", | ||
| ] | ||
| # Run the rule set of markdownlint 0.38 (used by markdownlint-cli2 0.18.1, | ||
| # the previous linter) instead of every rule rumdl enables by default. | ||
|
|
@@ -24,14 +25,15 @@ 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", "MD043", "MD044", "MD045", "MD046", "MD047", "MD048", "MD049", | ||
| "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 | ||
| ] | ||
|
|
||
| # Sphinx renders docs/ with MyST, so directive fences such as ```{toctree} | ||
|
|
@@ -80,3 +82,11 @@ ignore = ["x"] | |
|
|
||
| [MD053] | ||
| 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. | ||
| [MD044] | ||
| names = ["PyAthena", "Athena", "SQLAlchemy", "fsspec", "Polars", "PyArrow", "pandas"] | ||
|
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Self-review round one (implementation behavior)
Result: CLEAN Checks:
Noted for round two:
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Correction to round one (found after merge, db5edc9) Round one said that, without the The disable comments are still needed to keep MD044 from reporting the labels. Without them, the auto-fix makes a label's spelling differ from its |
||
| code-blocks = false | ||
| whole-words = true | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -102,7 +102,7 @@ uv run --env-file .env pytest -n 1 tests/pyathena/test_cursor.py -v | |
|
|
||
| ### Markdown Lint | ||
|
|
||
| `docs/**/*.md`, `benchmarks/*.md`, `scripts/**/*.md`, `cloudformation/**/*.md`, and project-root `*.md` files are linted with [rumdl](https://github.com/rvben/rumdl). The config lives at `.rumdl.toml`. CI runs lint + Sphinx build on PRs that touch docs (`.github/workflows/docs-lint.yaml`). | ||
| `docs/**/*.md`, `benchmarks/*.md`, `scripts/**/*.md`, `cloudformation/**/*.md`, `.agents/skills/**/*.md`, and project-root `*.md` files are linted with [rumdl](https://github.com/rvben/rumdl). The config lives at `.rumdl.toml`. CI runs lint + Sphinx build on PRs that touch docs (`.github/workflows/docs-lint.yaml`). | ||
|
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Self-review round two (claims, callers, operational effects)
Result: FINDINGS (PR description only; no code or docs repair) Claims checked:
Corrections made to the PR body:
|
||
|
|
||
| `rumdl` is pinned in `.mise.toml`, so [`mise`](https://mise.jdx.dev/) installs the exact version used in CI. Run locally: | ||
|
|
||
|
|
||
There was a problem hiding this comment.
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)
codex exec --sandbox read-only), modelgpt-6-astra, session01a1b461-da50-7af3-8709-c02ec94040442a60ecc1f2a7a6bd0d9293525a41ea0d642a00826cb01956bb79e540567632677c463c825f151cd7rumdlchecks were allowed.Result: CLEAN
Reviewer output:
Covered all 20 changed files: rumdl configuration and file discovery; documentation meaning, identifiers, links, MyST targets, headings and tables; related instructions and CI; and license-checker behavior and remaining test coverage.
CLEAN
.jsoncfiles or dangling references remain. The deleted test row covered the removed syntax; retained formats and the fallback remain represented in existing tests.No actionable pre-existing issues were identified within scope.
Validation was read-only inspection and permitted rumdl checks. No builds, tests, edits or GitHub access occurred; rendered-output assessment was static.