Skip to content

Add documentation on pylint/mypy checker overlap#15404

Draft
JennyPng wants to merge 1 commit intoAzure:mainfrom
JennyPng:pylint-issue-3226
Draft

Add documentation on pylint/mypy checker overlap#15404
JennyPng wants to merge 1 commit intoAzure:mainfrom
JennyPng:pylint-issue-3226

Conversation

@JennyPng
Copy link
Copy Markdown
Member

Fixes #3226

Adds documentation analyzing the overlap between custom pylint checkers and mypy, with a comparison table and recommendations.

Key Finding

There is minimal actual overlap — most pylint rules check SDK-specific conventions (docstrings, naming, imports) that mypy cannot enforce. The two tools are complementary.

Changes

  • Added "Overlap with mypy" section to README.md with comparison table
  • Updated CHANGELOG.md

Addresses Azure#3226. Adds a section to README.md
documenting the overlap between pylint custom checkers and mypy,
with a comparison table and recommendations for when to use each tool.

Conclusion: there is minimal actual overlap - most pylint rules check
SDK-specific conventions that mypy cannot enforce.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@JennyPng JennyPng force-pushed the pylint-issue-3226 branch from e92fda4 to ae1902b Compare April 30, 2026 17:19
@azure-sdk
Copy link
Copy Markdown
Collaborator

The following pipelines have been queued for testing:
java - template
java - template - tests
js - template
net - template
net - template - tests
python - template
python - template - tests
You can sign off on the approval gate to test the release stage of each pipeline.
See eng/common workflow

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.

[pylint] Integrate typing and docstring checkers

2 participants