Skip to content

[codex] Fix doccmd pylint ignores#3010

Merged
adamtheturtle merged 1 commit into
mainfrom
adamtheturtle/fix-pylint-ignore-doccmd
May 18, 2026
Merged

[codex] Fix doccmd pylint ignores#3010
adamtheturtle merged 1 commit into
mainfrom
adamtheturtle/fix-pylint-ignore-doccmd

Conversation

@adamtheturtle

@adamtheturtle adamtheturtle commented May 18, 2026

Copy link
Copy Markdown
Member

Updates doccmd to 2026.5.16 and extends the pylint per-file ignores for generated documentation examples.

The doccmd update now writes generated examples inside doccmd_<hash>/ directories, so the previous flat-file ignore patterns no longer suppressed invalid-name for those transient files.

Validated with doccmd running pylint, the pylint-docs prek hook, pyproject-fmt, and the repository pre-push hooks.


Note

Low Risk
Low risk: only bumps a dev-only documentation generator and adjusts pylint ignore globs to match its new generated-file layout; no runtime code or production dependencies change.

Overview
Updates the dev dependency doccmd to 2026.5.16.

Expands pylint per-file-ignores patterns to also suppress invalid-name for generated doc examples that are now written under nested doccmd_*/* directories (including under docs/source/).

Reviewed by Cursor Bugbot for commit 4585e0d. Bugbot is set up for automated code reviews on this repo. Configure here.

@adamtheturtle adamtheturtle marked this pull request as ready for review May 18, 2026 20:00
@adamtheturtle adamtheturtle merged commit 7664bc0 into main May 18, 2026
15 checks passed
@adamtheturtle adamtheturtle deleted the adamtheturtle/fix-pylint-ignore-doccmd branch May 18, 2026 20:00

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 4585e0d. Configure here.

Comment thread pyproject.toml
"deptry==0.25.1",
"doc8==2.0.0",
"doccmd==2026.5.6",
"doccmd==2026.5.16",

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Ruff per-file-ignores not updated for new directory structure

Medium Severity

The doccmd version bump changes generated file paths to use doccmd_<hash>/ directories, and the pylint per-file-ignores were updated accordingly, but the ruff lint.per-file-ignores patterns at "doccmd_*.py" and "docs/source/*.py" were not. Since * doesn't match path separators, files like doccmd_hash/example.py won't match doccmd_*.py, causing ruff to flag S101 (assert usage) in documentation examples that use assert (confirmed in README.rst and docs/source/index.rst).

Additional Locations (1)
Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 4585e0d. Configure here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant