Skip to content

Commit 6a5faeb

Browse files
Add Pylint documentation and changelog entry
1 parent dd7cf35 commit 6a5faeb

File tree

3 files changed

+55
-1
lines changed

3 files changed

+55
-1
lines changed

docs/changelog.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,22 @@ sidebar_label: Changelog
44
description: The latest updates and changes to CodeRabbit.
55
sidebar_position: 13
66
---
7+
### May 30, 2025
8+
9+
#### New Static Analysis Tool
10+
11+
We're excited to announce that [Pylint](https://github.com/PyCQA/pylint) is now supported on CodeRabbit!
12+
13+
- **Pylint**: A widely used static analysis and code quality tool for Python. It checks for errors, enforces a coding standard, and looks for code smells in your Python codebase by analyzing Python files (`.py`).
14+
15+
Here's why you'll love it:
16+
17+
- 🐞 **Instantly catches bugs** and style issues in your Python code.
18+
- 🪄 **Enforces clean, consistent code** across your entire team.
19+
- 🧩 **Fully customizable** to match your project's unique coding standards.
20+
21+
For more details, please visit our [tools documentation](https://docs.coderabbit.ai/tools/pylint).
22+
723

824
## May 25, 2025
925

docs/tools/list.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ For an overview of how CodeRabbit uses these tools when generating code reviews,
3333
| Plaintext | [LanguageTool][LanguageTool] | Grammar and Spell Checking |
3434
| Java | [PMD][PMD] | Code Quality |
3535
| Protobuf | [Buf][Buf] | Code Quality |
36-
| Python | [Ruff][Ruff] | Code Quality |
36+
| Python | [Ruff][Ruff], [Pylint][Pylint] | Code Quality |
3737
| Regal | [Regal][Regal] | Code Quality |
3838
| Ruby | [RuboCop][RuboCop], [Brakeman][Brakeman] | Code Quality, Code Security |
3939
| Rust | [Clippy][Clippy] | Code Quality |
@@ -77,3 +77,4 @@ For an overview of how CodeRabbit uses these tools when generating code reviews,
7777
[Luacheck]: /tools/luacheck.md
7878
[Brakeman]: /tools/brakeman.md
7979
[Clippy]: /tools/clippy.md
80+
[Pylint]: /tools/pylint.md

docs/tools/pylint.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: Pylint
3+
sidebar_label: Pylint
4+
description: CodeRabbit's guide to Pylint.
5+
---
6+
7+
```mdx-code-block
8+
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
9+
10+
<ProPlanNotice />
11+
```
12+
13+
[Pylint](https://pylint.pycqa.org/) is a static code analysis tool for Python. It checks your Python code for errors, enforces a coding standard, and looks for code smells.
14+
15+
## Supported Files
16+
17+
Pylint will run on files with the following extensions:
18+
19+
- `*.py`
20+
21+
## Features
22+
23+
Pylint can detect many issues such as:
24+
25+
- Coding standard violations (PEP8)
26+
- Unused variables and imports
27+
- Undefined variables
28+
- Code smells and refactoring suggestions
29+
- Error-prone constructs
30+
- And many more
31+
32+
## Links
33+
34+
- [Pylint Official Website](https://pylint.pycqa.org/)
35+
- [Pylint GitHub Repository](https://github.com/pylint-dev/pylint)
36+
- [Pylint Documentation](https://pylint.pycqa.org/en/latest/)
37+
- [Message Control](https://pylint.pycqa.org/en/latest/user_guide/message-control.html)

0 commit comments

Comments
 (0)